Skip to main content

Quickstart

Get an API key and make your first authenticated call in about five minutes. Then pick up working code for whatever you are building next.


Step 1 - Get your credentials​

Every request needs two things:

CredentialWhat it isHow you get it
API keyIdentifies your Intelomatic tenantIssued during onboarding
Access tokenShort-lived OAuth2 tokenYou request it yourself (Step 2)
Don't have a key yet?

Contact us to register an Intelomatic tenant and receive your API key.


Step 2 - Exchange your credentials for a token​

curl -X POST 'https://api-gw.sovereignsolutions.com/gateway/authen/oauth/token?api-key=$API_KEY' \
-d 'grant_type=password' \
-d 'username=$USERNAME' \
-d 'password=$PASSWORD'
{
"access_token": "<JWT>",
"token_type": "bearer",
"expires_in": 3600,
"refresh_token": "<token>"
}

Keep the access_token. Every other endpoint needs it.

Full details: Authentication reference


Step 3 - Make your first API call​

Turn a place name into coordinates:

curl -X POST 'https://api-gw.sovereignsolutions.com/gateway/$TENANT/api/app-base/geo-locations/search?api-key=$API_KEY' \
-H 'Authorization: Bearer $TOKEN' \
-H 'Content-Type: application/json' \
-d '{"searchKey": "Mumbai"}'
{
"docs": [
{
"name": "Mumbai",
"latitude": 19.0760,
"longitude": 72.8777,
"location_llt": "19.0760,72.8777",
"resultType": 2
}
]
}

If you got coordinates back, your credentials work.

Full details: Geocode API


Try it without writing code​

The Web SDK Playground runs every Map SDK capability in the browser with editable source - the fastest way to see whether something does what you need.


Where to go next​

I want to…Go to
See every endpoint, parameter and payloadAPI Reference
Install on iOS, Android, React Native or FlutterSDKs & Platform Guides
Understand what each capability solvesSolutions