API authentication
To interact with the Zamry API, you need an access token for authorization. This guide will walk you through obtaining an access token and using it with Zamry's services.
Key Points About Zamry Access Tokens
-
App and Project Association:
- Access Tokens and Apps: Each access token is linked to a specific app. An app is a software tool or program that uses/interacts with the API.
- Apps and Projects: Apps are grouped under a project. A project is a collection of related systems, such as an Android app, a web app, and a backend service, all working towards common goals.
-
Token Generation:
- Creating Tokens: Access tokens are generated through the API. You won’t find tokens on your dashboard. Use the API endpoint to create a token. For details, refer to Token Creation Endpoint (opens in a new tab).
-
Token Expiration:
- Validity: Tokens are valid for 2 hours. After expiration, generate a new token to continue accessing Zamry API services.
-
Token Revocation:
- Revoking Tokens: You can revoke an access token through the Revocation Endpoint (opens in a new tab) or your dashboard. Revoking a token immediately renders it invalid, preventing further access.
In Summary
To get an access token:
- Generate a Token: Use the Token Creation Endpoint (opens in a new tab) to generate a new token.
- Be aware of Expiration: Take note of the 2-hour validity period and renew your token as needed.
- Revoke if Necessary: If you need to revoke a token, use the Revocation Endpoint (opens in a new tab) or your dashboard.