1. How to develop test applications using our API?
You have an ability to build a test application on our platform using the test keys. Further information can be found in our API reference.
2. How to get production credentials for my app?
To get the unique keys for your application, you have to fill in the application form on a Developers page. Specify the name and the description of your app and submit the form. We will review your data and email you the keys as soon as your application is approved.
3. Is Atlaz API free?
Sure. No matter what subscription plan you are on, Atlaz API is completely free.
4. What data can I access through API?
You may have access to all the data with an exception of Atlaz unique features. You can perform standard operations (add, edit, remove or delete objects; change attributes) with basic Atlaz elements (Tasks, Columns, Boards, Projects, etc.). Please consult the complete API reference for more information.
5. Can I change my credentials?
If you need to change your app credentials or remove them completely, contact us at email@example.com.
6. How does OAuth2 work?
OAuth 2 is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. You can learn more about the framework here.
A short summary of the authorization flow:
You are presented with Atlaz consent screen (login required) with the application name and asking for permission for the app to access the user's data. When the user allows access, we redirect user to the app’s redirect URI (provided by you on app registration step) and you can retrieve an authorization code at this URI. The code is then exchanged for a set of tokens; the access token is used for all API calls and has a short TTL, while the refresh token is only used to get new access tokens.
7. What is a scope of API requests?
Atlaz API requests are executed on behalf of the end-user, who granted permissions for the third-party app through OAuth2 protocol. It means that the data available through the API is only the data visible and accessible to that exact user.
8. Are there any request limits?
To help prevent strain on Atlaz servers, our API applies rate limits per API key for all issued tokens. There is a limit of 600 requests per second. If a request exceeds the limit, Atlaz returns a 429 error.