API authentication
The Bureau Works API documentation is available for our customers:
We require requests made to our API to be authenticated using an authentication token in the request header X-AUTH-TOKEN. This token can be retrieved through the auth endpoint and it takes only a few steps to use it properly.
First, you need to retrieve your API credentials from the
Securityon your profile page:
2. Once you have the credentials in hand, you’re able to call the
auth endpoint. This is how a request to this endpoint looks like using Postman:
3. After you click on
Send, you should receive a response with your token in the header X-AUTH-TOKEN:
4. Now, all you need is to make sure you copy this header to every subsequent request you make to our API and you’re good to go!
Beware that your token will expire eventually. When this happens, you can start from step 2. You don’t need to generate new API credentials!