Before you integrate
- Use the API base URL supplied by Gomobile and the endpoints documented in this reference.
- Create a dedicated API key for one integration or environment.
- Keep the secret in a server-side secret manager.
- Use HTTPS and send the key in the
X-API-Keyrequest header. - Plan for expiration, disabling, revocation, and replacement.
Authentication model
API keys are organization-scoped machine credentials. When creating one in the web application, you choose an Admin, Manager, or Agent role to determine available operations. The role cannot be changed after creation. Individual endpoints can impose additional restrictions.Authenticate with an API key
Create, store, send, disable, and revoke a key safely.
Learn the API basics
Configure the base URL, pagination, errors, and safe test environment before making a request.
API access and support
Find connection requirements and help for integration needs not covered in this reference.