Quickstart

Make your first call with nothing but an API key, then add a bearer token for the APIs that read and write your tenant's data.

Step 1 - Get your API key

Credential	What it is	Needed for
API key (api-key query parameter)	Identifies your Intelomatic tenant	Every call
Access token (Authorization: Bearer)	Short-lived OAuth2 token you request yourself	Tenant APIs only (Step 3)

Don't have a key yet?

API keys are issued during onboarding. Contact us to register an Intelomatic tenant.

Step 2 - Make your first call

Location, map and route APIs need only the API key - no token, no tenant in the URL. Search for a place:

curl

curl -X POST 'https://api-gw.sovereignsolutions.com/gateway/geocode/search?api-key=$API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"searchKey": "coffee", "skip": 0, "take": 10}'

The response lists matching places in docs[], each with name, latitude and longitude. If you got places back, your key works.

Full contract: Geocode API

Step 3 - Call a tenant API

APIs that work with your tenant's records (employees, customers, visits, tracking) need a bearer token as well as the API key, and your tenant code in the URL.

Exchange your credentials for a token:

curl

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'

200 OK

{
  "access_token": "<JWT>",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "<token>"
}

Then send it with the API key - for example, search the employees in your tenant:

curl

curl -X POST 'https://api-gw.sovereignsolutions.com/gateway/$TENANT/employee/search?api-key=$API_KEY' \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"skip": 0, "take": 20, "searchKey": "field_user_01"}'

Full contracts: Authentication API · Employee Management API

Try it without writing code

The API Playground sends real requests to every endpoint from the browser. The Map SDK Playground runs every Map SDK capability with editable source.

Where to go next

I want to…	Go to
See which credentials each API needs	API Reference - Credentials
Understand an error response	Errors
Install on iOS, Android, React Native or Flutter	SDKs & Platform Guides
See what each capability solves	Solutions