Quick reference

1
# All API requests
2
-H "tomtom-api-key: YOUR_API_KEY"
3
-H "Authorization: Bearer YOUR_AUTH_TOKEN"
4

5
# GEM API only (add this header)
6
-H "X-Version: 1"
7

8
# POST requests (add this header)
9
-H "Content-Type: application/json"

1
# Get authorization token
2
az account get-access-token --scope https://gem.core.orbis.tomtom.com/user_impersonation
3

4
# Login with service principal (from GEM UI credentials)
5
az login --service-principal \
6
  --username <CLIENT_ID> \
7
  --password <CLIENT_SECRET> \
8
  --tenant <TENANT_ID>

1
az storage blob upload \
2
  --account-name <STORAGE_ACCOUNT> \
3
  --container-name <CONTAINER> \
4
  --name <FILENAME>.parquet \
5
  --file /path/to/local/file.parquet \
6
  --auth-mode login

1
az storage blob download \
2
  --account-name <STORAGE_ACCOUNT> \
3
  --container-name <CONTAINER> \
4
  --name predictions.parquet \
5
  --file /path/to/destination/predictions.parquet \
6
  --auth-mode login

1
{"id": 5707295, "is_navigable": true, "geometry": "LINESTRING (4.89 52.37, 4.90 52.38)"}

1
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages" \
2
  -H "tomtom-api-key: $TOMTOM_API_KEY" \
3
  -H "Authorization: Bearer $AUTH_TOKEN"

1
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/$STORAGE_ID/credentials" \
2
  -H "tomtom-api-key: $TOMTOM_API_KEY" \
3
  -H "Authorization: Bearer $AUTH_TOKEN"

1
curl -X POST "https://api.tomtom.com/maps/orbis/platform/gem/jobs" \
2
  -H "tomtom-api-key: $TOMTOM_API_KEY" \
3
  -H "Authorization: Bearer $AUTH_TOKEN" \
4
  -H "Content-Type: application/json" \
5
  -H "X-Version: 1" \
6
  -d '{
7
    "storageId": "storage-001",
8
    "inputFileName": "my_data.parquet",
9
    "matchingType": "road"
10
  }'

1
curl -X GET "https://api.tomtom.com/maps/orbis/platform/gem/job/$JOB_ID" \
2
  -H "tomtom-api-key: $API_KEY" \
3
  -H "Authorization: Bearer $TOKEN" \
4
  -H "X-Version: 1"