Skip to content

Commit 4922dc0

Browse files
committed
replaced documentation links to new ones
1 parent 8385e57 commit 4922dc0

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Based on:
2121
- [Using Maven](#using-maven)
2222
- [Using Gradle](#using-gradle)
2323
- [Manual Installation](#manual-installation)
24-
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
24+
3. [API Documentation Links](#api-documentations)
2525
4. [API Endpoints](#api-endpoints)
2626
5. [Fields and Methods Availability](#fields-and-methods-availability)
2727
6. [Authentication Setup](#authentication-setup)
@@ -112,14 +112,17 @@ Then include the following JARs in your classpath:
112112
- `target/ipgeolocation-sdk-java-2.0.1.jar`
113113
- All JARs in `target/lib/`
114114

115-
## API Plan Tiers and Documentation
115+
## API Documentations
116116

117-
The documentation below corresponds to the four available API tier plans:
118-
119-
- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
120-
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
121-
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
122-
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
117+
The documentation below corresponds to the available APIs:
118+
- [**Overview**](https://ipgeolocation.io/documentation.html)
119+
- [**IP GeoLocation API**](https://ipgeolocation.io/documentation/ip-location-api.html)
120+
- [**IP Security API**](https://ipgeolocation.io/documentation/ip-security-api.html)
121+
- [**ASN API**](https://ipgeolocation.io/documentation/asn-api.html)
122+
- [**IP Abuse Contact API**](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html)
123+
- [**Timezone API**](https://ipgeolocation.io/documentation/timezone-api.html)
124+
- [**User-Agent API**](https://ipgeolocation.io/documentation/user-agent-api.html)
125+
- [**Astronomy API**](https://ipgeolocation.io/documentation/astronomy-api.html)
123126

124127
For a detailed comparison of what each plan offers, visit the [Pricing Page](https://ipgeolocation.io/pricing.html).
125128

@@ -160,7 +163,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
160163
| *UserAgentAPI* | [**getUserAgentOfCustomString**](https://github.com/IPGeolocation/ip-geolocation-api-java-sdk/blob/master/docs/UserAgentAPI.md#getuseragentofcustomstring) |||||
161164

162165
> [!TIP]
163-
> The availability of fields in every API endpoint across all API plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response](https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response).
166+
> The availability of fields in every API endpoint across Free and Paid plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response](https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response).
164167
165168
## Authentication Setup
166169
To authenticate API requests, you need an API key from [ipgeolocation.io](https://ipgeolocation.io/).
@@ -207,7 +210,7 @@ This section provides usage examples of the `getIPGeolocation()` method from the
207210
- `dma`
208211
- `time_zone`
209212

210-
For complete details, refer to the official documentation: [IP Geolocation API Documentation](https://ipgeolocation.io/ip-location-api.html#documentation-overview)
213+
For complete details, refer to the official documentation: [IP Geolocation API Documentation](https://ipgeolocation.io/documentation/ip-location-api.html)
211214

212215
The `ip` parameter in the SDK can accept any valid IPv4 address, IPv6 address, or domain name. If the `ip()` method is not used or the parameter is omitted, the API will return information about the public IP address of the device or server where the SDK is executed.
213216

@@ -636,7 +639,7 @@ System.out.println(response);
636639

637640
This section provides usage examples of the `getIPSecurity()` method from the SDK across various subscription tiers. Each example demonstrates different ways to query threat intelligence and risk metadata using parameters like fields, excludes, and optional modules.
638641

639-
For full API specifications, refer to the [official IP Security API documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview).
642+
For full API specifications, refer to the [official IP Security API documentation](https://ipgeolocation.io/documentation/ip-security-api.html).
640643

641644
### Get Security only fields
642645

@@ -679,7 +682,7 @@ SecurityAPIResponse response = api.getIPSecurity()
679682
.execute();
680683
```
681684
> [!NOTE]
682-
> You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.
685+
> You can get all the available fields in a paid plan in combination with security data, when subscribed to paid plan.
683686
684687
### Request with Field Filtering
685688

@@ -729,7 +732,7 @@ This section provides usage examples of the `getAsnDetails()` method from the SD
729732
> [!NOTE]
730733
> ASN API is only available in the Advanced Plan.
731734
732-
Refer to the [ASN API documentation](https://ipgeolocation.io/asn-api.html#documentation-overview) for a detailed list of supported fields and behaviors.
735+
Refer to the [ASN API documentation](https://ipgeolocation.io/documentation/asn-api.html) for a detailed list of supported fields and behaviors.
733736

734737
### Get ASN Information by IP Address
735738

@@ -873,7 +876,7 @@ This section demonstrates how to use the `getAbuseContactInfo()` method of the A
873876
> [!NOTE]
874877
> Abuse Contact API is only available in the Advanced Plan.
875878
876-
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
879+
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html) for details on all available fields.
877880
### Lookup Abuse Contact by IP
878881
```java
879882
import io.ipgeolocation.sdk.api.AbuseContactAPI;
@@ -961,7 +964,7 @@ class AbuseResponse {
961964

962965
This section provides usage examples of the `getTimezone()` method from the SDK, showcasing how to fetch timezone and time-related data using different query types — IP address, latitude/longitude, and timezone ID.
963966

964-
For full API specifications, refer to the [Timezone API documentation](https://ipgeolocation.io/timezone-api.html#documentation-overview).
967+
For full API specifications, refer to the [Timezone API documentation](https://ipgeolocation.io/documentation/timezone-api.html).
965968

966969
### Get Timezone by IP Address
967970

@@ -1337,7 +1340,7 @@ class TimeZoneResponse {
13371340

13381341
This section provides usage examples of the `convertTimezone()` method from the SDK. The Timezone Converter API allows you to convert a specific time from one timezone to another using timezone identifiers; coordinates; city; IATA/ICAO code or UN/LOCODE and optional date/time inputs.
13391342

1340-
For more details, refer to official documentation: [Timezone Converter API](https://ipgeolocation.io/timezone-api.html#convert-time-bw-time-zones).
1343+
For more details, refer to official documentation: [Timezone Converter API](https://ipgeolocation.io/documentation/timezone-api.html#convert-time-between-time-zones).
13411344

13421345
### Convert Current Time from One Timezone to Another
13431346

@@ -1369,7 +1372,7 @@ Similarly, you can convert time from any timezone to another timezone using loca
13691372

13701373
This section provides usage examples of the `getUserAgent()` method from the SDK. The User Agent API extracts and classifies information from user agent strings, including browser, engine, device, OS, and type metadata.
13711374

1372-
For full explanation, visit the [User Agent API documentation](https://ipgeolocation.io/user-agent-api.html#documentation-overview).
1375+
For full explanation, visit the [User Agent API documentation](https://ipgeolocation.io/documentation/user-agent-api.html).
13731376

13741377
### Parse a Basic User Agent String
13751378

@@ -1442,7 +1445,7 @@ System.out.println(response);
14421445

14431446
This section provides usage examples of the `getAstronomy()` method from the SDK, allowing developers to fetch sun and moon timings and position data based on coordinates, IP, or location string.
14441447

1445-
Refer to the [official Astronomy API documentation](https://ipgeolocation.io/astronomy-api.html#documentation-overview) for more details.
1448+
Refer to the [official Astronomy API documentation](https://ipgeolocation.io/documentation/astronomy-api.html) for more details.
14461449

14471450
### Lookup Astronomy by Coordinates
14481451

0 commit comments

Comments
 (0)