This guide walks you through the process of setting up API requests utilizing tools like Insomnia, e.g. for checking the checks.
1. Generating a Private Access Token
Access your organisational settings and navigate to Private Access Tokens in the menu.
Click on Generate New Access Token to create a new token.
Provide a name and select your desired scopes from the dropdown menu (e.g., for jobs and orders: zaikio.jobs.rw and zaikio.orders.rw).
Confirm by clicking Create Private OAuth Access Token. The generated token will be displayed once in a yellow box at the top of the page.
Note
The token will only be displayed once due to security reasons. If you return back to this page it's not displayed anymore. In that case you have to create a new token.
2. Generate API Calls
Insert the generated token into your preferred tool as Bearer token.
Explore our documentation to find a comprehensive list of API endpoints.
Choose the environment from which the access token is created – sandbox (for testing) or production – and copy the link into your tool.
Append the desired endpoint to your URL and send the request as JSON.
Note
Since our API reference is interactive, you can use the access token also there.
You find more infos in our docs.