For the most part, the data stored in BrynQ can also be retrieved via REST APIs. Of course, authorization also applies here. This article describes how to create an API token. The article "REST API" describes how the REST API can actually be used.
Creating a token
- A token gives rights to retrieve data from certain parts of BrynQ. For example, it is possible to retrieve data with all users, or data from connectors, etc. The token required for this is created as follows:
- Navigate to Settings > General > API Access;
- At the top right of the screen, click Add API token;
- Give the token a clearly identifiable and descriptive label;
- Under "Page Rights," specify the pages from which the token can retrieve data. The token only gives Read rights to these pages. Note that only pages to which the user currently has access can be chosen here.
- If there are multiple clients (which will almost never be the case), possibly specify which clients this token applies to;
- For security, it may be desirable to give the token an end date and time when the token loses its validity;
- Click on "Save."
- Save the token that now appears on the screen somewhere. It cannot be requested again. Click on Ok.
The token can be used in the Authorization header. The key must be provided with SalureToken. If the token would be abcd1234 the header will look like this: { "Authorization": "SalureToken abcd1234"}.