Skip to content

Commit f366237

Browse files
Merge pull request #28 from IPGeolocation/MudassarTariq-patch-1
Update README.md
2 parents 51eedbf + d129f29 commit f366237

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ Whether you're enriching signup forms with ip geolocation data, localizing conte
1818
- [Gradle](#using-gradle)
1919
- [Manual Installation](#manual-installation)
2020
2. [Authentication Setup](#authentication-setup)
21-
3. [API Endpoints](#api-endpoints)
21+
- [1. How to Get Your API Key](#how-to-get-your-api-key)
22+
- [2. Setup API Key](#setup-api-key)
23+
4. [API Endpoints](#api-endpoints)
2224
3. [IP Geolocation Examples](#ip-geolocation-examples)
2325
- [1. Developer (Free) Plan Examples](#1-developer-plan-examples)
2426
- [2. Standard Plan Examples](#2-standard-plan-examples)
@@ -114,7 +116,27 @@ Then include the following JARs in your classpath:
114116

115117
# Authentication Setup
116118

117-
To authenticate API requests, you need an API key from [ipgeolocation.io](https://ipgeolocation.io/). Once obtained, configure your API client as follows:
119+
To authenticate API requests, you need an API key from [ipgeolocation.io](https://ipgeolocation.io/).
120+
121+
## How to Get Your API Key
122+
123+
1. **Sign up** here: [https://app.ipgeolocation.io/signup](https://app.ipgeolocation.io/signup)
124+
2. **Log in** to your account: [https://app.ipgeolocation.io/login](https://app.ipgeolocation.io/login)
125+
3. After logging in, navigate to your **Dashboard** to find your API key: [https://app.ipgeolocation.io/dashboard](https://app.ipgeolocation.io/dashboard)
126+
127+
## API Plan Tiers and Documentation
128+
129+
The documentation below corresponds to the four available API tier plans:
130+
131+
- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
132+
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
133+
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
134+
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
135+
136+
For a detailed comparison of what each plan offers, visit the [Pricing Page](https://ipgeolocation.io/pricing.html).
137+
138+
## Setup API Key
139+
Once you've obtained the api key, configure your API client as follows:
118140

119141
```java
120142
import invoker.io.ipgeolocation.sdk.ApiClient;

0 commit comments

Comments
 (0)