API Keys
Learn more about API Keys and how to integrate them with our platform.
Last updated
Learn more about API Keys and how to integrate them with our platform.
Last updated
The API Keys allow you to grant access to an API to your BMS account. This will make it easier to keep track of your metrics using an external platform. Some APIs, like Zapier, can be configured to create Ads based on Google Drive Files. When it comes to the APIs there is a lot we can do, and every API will have its particularities. However, the integration of these APIs with the BMS console is similar. This article aims to help you perform this integration.
The API Keys are available on the permissions page, to access it click on your account's name on the top right corner, then click on Permissions, now on the menu at the left, click on API Keys.
It is possible to Create New API Keys and it is also possible to Link an Existing API Key.
Select Create API Key, then fill in the details.
Name: Set a name for your API Key.
Tags: Set tags for your organization.
This option allows you to link an existing API Key from another BMS account.
By linking an existing API Key, you will grant access to your account for the linked API Key users. Use policies to control what can be done through this API Key.
Select Link existing API Key, then fill in the details
API Key ID: Inform the API Key ID you want to link.
After creating the API Key, you need to generate an Access Code before you can start using it. If you select a linked API Key, this tab will remain disabled, as there is no need to create an access code. In such cases, you will use the Access Code of the linked API, which can be provided by its creator.
Select the API Key to which the access code needs to be created.
Insert a description for your access code.
Right after saving your changes, the access code secret will be displayed like this:
You can create up to 2 access codes per API Key, each code is valid for 365 days, we strongly advise you to create a new code a few weeks before the actual code expires to guarantee that the services relying on this API Key don't stop.
To interact with BMS services programmatically, you need to include the Access Code generated in your API requests. Your access will be restricted to the specific APIs that your API key is authorized to use. You can include the Access Code in your requests using one of the following methods:
In the Query String: Add the Access Code to the URL as a query parameter apiKey. You can also use the copy button to avoid typing errors.
For a complete list of available BMS APIs, please refer to our documentation.
Attention! Be careful when deleting an access code, this action cannot be undone, and all services relying on this access code will stop working.
Click on to add an API Key
Policies: Set access policies that limit what this API Key grants access to, click on to add your policies. Every policy has a name and a description of what it gives access to. You can also create the API Key without selecting a policy.
After selecting all the needed policies, click on to confirm your selection.
Click on to save your API Key.
Click on to add an API Key.
Policies: Set access policies that limit what this API Key grants access to by clicking on to add your policies. Every policy requires a name and a description of the access it provides. When linking API Keys, at least one policy must be selected.
After selecting all the necessary policies, click on to confirm your selection.
Click on to save your API Key.
Click on to create an access code for the selected API Key.
Click on to save your access code.
It's possible to copy the secret using the copy button, , or download it into a '.txt' file.
In the Request Header: Copy the "x-api-key", for this, use the button . This will avoid typing errors, and paste it into the header of your requests.
All the API Keys details are available for edition by clicking on at the same row as the API Key you want to edit. After making your changes, click on to save them.
You can also delete an API Key by clicking on , and then confirming the action on . Be careful - this action cannot be undone. Keep in mind that any API relying on the deleted API Key will stop working. Regarding Access Codes, you can view the access code secret and download the credentials by clicking on at the same row as the access code you want to view. The access code description can also be edited as well by clicking on at the same row as the access code you wish to edit. Once you have finished making your changes, click on to save them.
You can also delete access codes. This is useful in cases where the data may have been compromised. To do this, firts to disable the code by toggling the switch to the right of the access code off , then clicking on at the same row as the access code you want to delete, and confirming by clicking on .
