How to create an API Token step by step
Carriers must share the following items in order to run automated tracking with this GPS:
- API Token
API Token
Preliminary considerations
ATTENTION: Only the following user roles have permissions to create API TOKENS:
- Full Admin
- Standard Admin
- Custom role created by your organization, containing the following permissions
1) edit permissions to see and edit API TOKENS and
2) edit permissions to create, edit, and delete users, roles, tags.
In any case, users must have access to ENTIRE ORGANIZATION.
If you do not see the options we will show you below for API TOKENS, please check and make sure you have a user with sufficient permissions.
How to create an API Token step by step
Click on the CONFIGURATION / SETTINGS cogwheel at the bottom edge of your Samsara panel to access the configuration options.
Once inside the list of configurations, click on DEVELOPER - API TOKENS.
Click on the top right corner, on ADD API TOKEN.
And then define the token properties:
- NAME. We recommend that it be descriptive and easy to identify. For example, Fr8App.
- TAG ACCESS. Select the tag access level.
- PERMISSION SCOPE. Select the scope and permissions of the token. Simply grant READ-ONLY permissions in the Global dropdown.
The API TOKEN has 2 elements, name and token, and they will appear at the top of the screen.
It is very important that you copy and save these two elements on the spot, as once you copy it and/or refresh the page, the token text will no longer be visible.
Please share the access token with our integrations team.
In case you don't write it down and need to see it in the future, you would need to REGENERATE the token.
Valid API Token Example
This is what a Samsara API Token looks like:
Contains 2 elements:
Name.
Access token.