After the initial setup, access to Britive APIs is protected by OAuth 2.0 authorization. To use a Britive API, you must first generate an API token that can be used to execute the API.
URL of the Britive Application
The URL mentioned in the APIs represents the URL of the Britive application.
For example:
| POST | {{url}}/api/user-tags |
An example of a {url} can be https://demo.britive-app.com. In this example URL, replace the demo with the tenant name provided to you by Britive.
Note:
Ensure that a tenant has been onboarded. If a tenant has not been onboarded, contact Britive for further assistance.
Generating an API Token
To create an API token, perform the following steps:
- Log in to Britive Application as an administrator.
- Click Admin -> Security.
- In API Tokens, click CREATE TOKEN. A pop-up window is displayed.
- In the pop-up window, enter the name of the API token.
- Click CREATE TOKEN.
This generates an API token that can be used in all API calls.
Note:
API tokens inherit the same privileges as the user who created the tokens. For security reasons, exercise caution when selecting which users are creating API tokens to use Britive APIs.