Samsara API token is used to enable the data interchange between Samsara and other applications or software, in this case - 10Speed.
10Speed TMS has an integration with Samsara. The integration can be added by the Samsara admin, the API token is created and added to the 10speed TMS.
In this article the permissions for the API token will be explained.
Accessing Samsara
Firstly, go to Samsara web and sign in;
After signing in the Samsara web page will be shown. To access the API token go to the left side of the screen and press Organization settings:
API tokens creation
When pressed on the organization settings new window will pop up, select API tokens on the left side of the screen:
When pressing on it, the information about the tokens will be visible:
The API token name - usually it is named after the application or software, where this token is going to be used for;
Access token number - the token itself;
Scope summary - a total of read and write permissions allowed by the token;
Tag access - who can access the token in the company;
Version - the date when the Samsara API token was given:
In order to get a new API token, press on Add an API token.
New API token settings
A new window will pop up where we suggest to enter this information:
Add company name;
Tag the access;
Select scopes. What is important in this step are the global settings. We suggest three options to choose from when adding a new token:
Global Write & Read - when chosen both options the users allow the TMS to read and write the data from Samsara.
Reading permissions allow 10Speed TMS to pull data from Samsara.
Writing permissions allow 10Speed TMS to push data to Samsara, meaning 10Speed can update data entries in Samsara. At this moment we do not have the functionality that would use Write permissions, in the future this might change, therefore we encourage to give Global Write access.
Global Read - if the option to choose Global Write does not suit the business needs, users can give the permission to Read all the data from Samsara. Reading the data would only allow the TMS to access data, it cannot be edited in Samsara by 10Speed TMS.
Minimum settings - if neither of the options suit our user, we recommend allowing these permissions, that are required to take advantage of most of the 10Speed features (see bellow):
Addresses: select Read addresses:
Assignments: Select Read Assignments:
Compliance - select All Read:
Driver workflow - select All Read:
Drivers - select All Read:
Equipment - select All Read:
Fuel & energy - select All read:
Maintenance - select All Read:
Safety & Cameras - select Read Safety Events & Scores:
Setup & Administration - select Read Attributes and Read Tags:
Trailers - select All Read:
Vehicles - select All Read:
Press Save;
Further information on how to use newly created token can be found here;
The token access information or the token name can be edited, token can be deleted, or token can be regenerated by pressing on the three-dot icon near the token:
Important to note - regenerating a new API token will disable an old one.