In order to start using the API, you should activate the API service for your Organization.
Follow the below steps to activate the API Service:
For legacy customers, the API service is free for the first 2 months so that you can test the service, develop your custom application and ensure that using API works well for your use case. After the trial period ends, you can contact us to request an extension.
After activating the API, you should create an Access Key. Click the CREATE icon on the page to proceed.
You can assign Access Roles to each Access Key to dictate what they are allowed to do. Please find below the Access Roles and their coverage
| Role | Definition |
| Fetch monitoring assets | can fetch the photos and/or videos recorded during a test session |
| List tasks | can fetch/query tasks |
| List tests | can fetch/query tests |
| List Users | can fetch/query users |
| Query test results | can fetch/query the results of a test session |
| Update tasks | can edit the properties of a task |
| Write tickets | can create new Tickets for a Task |
You can create multiple Access Keys, assign them different roles, then give the keys to different teams in your company, and manage their access and roles individually.
After assigning the desired roles and a title, lick SAVE to create the key.
After creating an Access Key, in the old screens, open the Access Key menu, reveal and write down the Private Key/Authorization Token associated with the Access Key.
In the new screens, click the View the Key button in the table to reveal the Private Key and Authorization Token.
Author
