If you are accessing your ActivityInfo data through the API, or through a third-party application such as Power BI, you will need to generate an API token.
Adding an API token in your account
-
Click on the icon with the arrow in the top-right corner to find the link to your profile settings.
-
Select the API Tokens menu item in the left-hand menu.
-
Click the Add button. This will open the dialog on the right-hand side.
-
Provide a label for your token in the Label text field
-
Decide on a labeling convention that suits your needs, such as the application name and device name.
-
Label each application and device accordingly, ensuring that each application+device combination has a unique label to ensure that you know which one to remove when finished with the application.
-
choose the Scope of your token and then click the Generate button to create a new API token.
After completing the steps above, you will get a message similar to the one in the following screenshot.
At this point, you must copy the API token. You can click on the Copy to clipboard button to do so and paste it where your external system can use it. Once you leave this page, you will no longer be able to see or copy the token!
Token scope: read-only or read and write?
You have two options for the scope of a token:
- read-only will allow external applications to only read data in your account. The application cannot add, change, or delete records in your databases.
- read & write will allow external applications to not only read your data, but also to modify it by adding, editing, or deleting records.
Note that a token can only limit actions in your account, therefore if you do not have the permission to edit records in a form, then a token with a 'read and write' scope in your account will not allow an external application to edit records either.
Revoking an API token
When you no longer need a token, you should revoke it as soon as possible.
- Open your profile settings and select the API Tokens section in the left-hand menu.
- Find the token you want to revoke and select it.
- Click the Revoke token button in the panel on the right of the screen.
It takes about 5 minutes for the token to be indefinitely removed from our systems after which any application using this token will no longer be able to access the data in your account.
A token which has been revoked can never be restored.