API overview
Request accessGEM API overview
In addition to the GEM User Interface, you can programmatically interact with Global Entity Matcher through a set of REST APIs. This enables automation of data workflows, integration with CI/CD pipelines, and building custom applications on top of GEM capabilities.
API access
GEM APIs are exposed through the TomTom API Gateway under api.tomtom.com. The system consists of two main API components:
Orbis Private Data Gateway API
The Private Data Gateway API manages secure cloud storage for your geospatial data. Use this API to:
- List available storage locations
- Retrieve storage details and configuration
- Obtain credentials for data upload/download operations
Base URL:
https://api.tomtom.com/maps/orbis/platform/private-gatewayGEM API
The GEM API handles the matching operations that align your data with GERS identifiers. Use this API to:
- Create new matching jobs
- Monitor job progress and status
- Retrieve job results and statistics
Base URL:
https://api.tomtom.com/maps/orbis/platform/gemPrerequisites for API usage
Before using the GEM APIs, ensure you have:
1. Access requirements
- TomTom account: Active account at my.tomtom.com
- API key: A valid API key with GEM API access enabled
- Project assignment: Assigned to a project with GEM access
2. Required API products
When creating your API key at my.tomtom.com/keys , ensure you enable:
- Orbis Private Data Gateway API - For storage management
- Orbis GEM API - For matching operations
3. Technical tools
- HTTP client:
curl, Postman, or any HTTP library - Azure CLI: Required for authentication and data upload/download, installed from Microsoft Azure CLI documentation
- Terminal access: Command-line interface on your machine
Next steps
- API Authentication - Learn how to authenticate API requests
- Storage Authentication - Learn how to access storage with obtained credentials
- Private Data Gateway API - Learn how to manage your storage
- GEM API - Learn how to run and monitor matching jobs
- FAQ - Find answers to common questions