Skip to content

Commit 12f1454

Browse files
Merge pull request #12 from IPGeolocation/feature/readme-updates
replaced documentation links to new ones
2 parents b15c528 + b3a6179 commit 12f1454

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
@@ -26,7 +26,7 @@ Based on:
2626
2. [Installation](#installation)
2727
- [Using Composer](#using-composer)
2828
- [Manual Installation](#manual-installation)
29-
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
29+
3. [API Documentation Links](#api-documentations)
3030
4. [API Endpoints](#api-endpoints)
3131
5. [Fields and Methods Availability](#fields-and-methods-availability)
3232
6. [Authentication Setup](#authentication-setup)
@@ -100,14 +100,17 @@ If you wish to manually include the SDK without Composer:
100100
composer install
101101
```
102102

103-
## API Plan Tiers and Documentation
103+
## API Documentations
104104

105-
The documentation below corresponds to the four available API tier plans:
106-
107-
- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
108-
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
109-
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
110-
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
105+
The documentation below corresponds to the available APIs:
106+
- [**Overview**](https://ipgeolocation.io/documentation.html)
107+
- [**IP GeoLocation API**](https://ipgeolocation.io/documentation/ip-location-api.html)
108+
- [**IP Security API**](https://ipgeolocation.io/documentation/ip-security-api.html)
109+
- [**ASN API**](https://ipgeolocation.io/documentation/asn-api.html)
110+
- [**IP Abuse Contact API**](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html)
111+
- [**Timezone API**](https://ipgeolocation.io/documentation/timezone-api.html)
112+
- [**User-Agent API**](https://ipgeolocation.io/documentation/user-agent-api.html)
113+
- [**Astronomy API**](https://ipgeolocation.io/documentation/astronomy-api.html)
111114

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

@@ -149,7 +152,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
149152
| *UserAgentApi* | [**parseBulkUserAgentStrings**](https://github.com/IPGeolocation/ip-geolocation-api-php/blob/master/docs/Api/UserAgentAPI.md#parse_bulk_user_agent_strings) |||||
150153

151154
> [!TIP]
152-
> 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).
155+
> 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).
153156
154157

155158
## Authentication Setup
@@ -197,7 +200,7 @@ This section shows how to use the `getIpGeolocation()` method from the PHP SDK a
197200
- `dma`
198201
- `timezone`
199202

200-
For the full list of supported fields and modules, please refer to the official [IP Geolocation API Documentation](https://ipgeolocation.io/ip-location-api.html#documentation-overview).
203+
For the full list of supported fields and modules, please refer to the official [IP Geolocation API Documentation](https://ipgeolocation.io/documentation/ip-location-api.html).
201204

202205
The `ip` parameter in the SDK can accept any valid IPv4 address, IPv6 address, or domain name. If the `ip=` parameter is not specified, the API will return information about the public IP of the machine where the SDK is running.
203206

@@ -717,7 +720,7 @@ try {
717720

718721
This section shows how to use the `getIpSecurityInfo()` method with various subscription tiers. Each example demonstrates how to query threat intelligence and risk metadata using parameters like `fields`, `excludes`, and `include`.
719722

720-
For the full API specs, refer to [IP Security API Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview).
723+
For the full API specs, refer to [IP Security API Documentation](https://ipgeolocation.io/documentation/ip-security-api.html).
721724

722725
### Get Default Fields
723726

@@ -786,7 +789,7 @@ try {
786789
```
787790

788791
> [!NOTE]
789-
> You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.
792+
> You can get all the available fields in a paid plan in combination with security data, when subscribed to paid plan.
790793
791794
### Request with Field Filtering
792795

@@ -856,7 +859,7 @@ This section provides usage examples of the `getAsnInfo()` method from the SDK.
856859
> [!NOTE]
857860
> ASN API is only available in the Advanced subscription Plan.
858861
859-
Refer to the [ASN API documentation](https://ipgeolocation.io/asn-api.html#documentation-overview) for a detailed list of supported fields and behaviors.
862+
Refer to the [ASN API documentation](https://ipgeolocation.io/documentation/asn-api.html) for a detailed list of supported fields and behaviors.
860863

861864
### Get ASN Information by IP Address
862865
```php
@@ -1024,7 +1027,7 @@ This section demonstrates how to use the `getAbuseContactInfo()` method of the A
10241027
> [!NOTE]
10251028
> Abuse Contact API is only available in Advanced subscription Plan.
10261029
1027-
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
1030+
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html) for details on all available fields.
10281031

10291032
### Lookup Abuse Contact by IP
10301033
```php
@@ -1133,7 +1136,7 @@ Sample Response:
11331136
## Timezone API Examples
11341137
This section provides usage examples of the `getTimezoneInfo()` method from the PHP SDK, showcasing how to fetch timezone and time-related data using different query types — IP address, latitude/longitude, timezone ID, IATA code, ICAO code, or UN/LOCODE.
11351138

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

11381141
### Get Timezone by IP Address
11391142
```php
@@ -1554,7 +1557,7 @@ Sample Response:
15541557
## Timezone Converter Examples
15551558
This section provides usage examples of the `convertTimeBetweenTimezones()` method from the SDK. The Timezone Converter API allows you to convert a specific time from one timezone to another using timezone identifiers and optional date/time inputs.
15561559

1557-
For more details, refer to the [Timezone Converter API documentation](https://ipgeolocation.io/timezone-api.html#convert-time-bw-time-zones).
1560+
For more details, refer to the [Timezone Converter API documentation](https://ipgeolocation.io/documentation/timezone-api.html#convert-time-between-time-zones).
15581561

15591562
### Convert Current Time from One Timezone to Another
15601563
```php
@@ -1599,7 +1602,7 @@ Similarly, you can convert time from any timezone to another timezone using loca
15991602
## User Agent API Examples
16001603
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.
16011604

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

16041607
### Parse a Basic User Agent String
16051608
```php
@@ -1682,7 +1685,7 @@ try {
16821685
## Astronomy API Examples
16831686
This section provides usage examples of the `getAstronomyDetails()` method from the SDK, allowing developers to fetch sun and moon timings and position data based on coordinates, IP, or location string.
16841687

1685-
Refer to the official [Astronomy API documentation](https://ipgeolocation.io/astronomy-api.html#documentation-overview) for more details.
1688+
Refer to the official [Astronomy API documentation](https://ipgeolocation.io/documentation/astronomy-api.html) for more details.
16861689
### Astronomy by Coordinates
16871690
```php
16881691
$apiInstance = new \Ipgeolocation\Sdk\Api\AstronomyAPI(

0 commit comments

Comments
 (0)