API tokens allow seamless integration with other software systems. For example, a FoodLogiQ account owner can use an API token to connect with an HR software system to automatically create new Roles and role permissions as new employees enter their system. Users can generate API tokens if their role is given that permission in the User Management screen.
Users will assign the appropriate Role permissions along with the ability to generate API tokens to this role. These permissions will be applicable to any user they create with that token.
- Click on Settings cogwheel in the top right-hand corner and choose User Administration from the drop-down menu.
- Choose the Roles tab and click the plus sign to create a new Role; alternatively you can update an existing role by clicking on it in the list view.
- Name the Role, check Generate API token and select the Role permissions.
- Add the new Role to a new or existing User to give them the ability to generate the API Token and Save.
Note: The Administrator may choose to create a new user to use the API generating role. For example, an Administrator creates a new role called “Shipping Integration” that has access to generate an API Token along with read and write access to shipping & receiving events. The Administrator then creates a new user with only that role. The new user logs in and creates the token. The integration token will only have permissions to work with shipping & receiving events. If the role permissions are updated, the user created with that token will see their access updated to the new permissions as well.
- Once the role is enabled, the appropriate user will click on Settings cogwheel in the top right-hand corner and choose Integrations from the drop-down menu.
- Click Add API Token on the API Token tab.
- Name or label the API Token and click Create.
- Copy the API token to use for integration purposes. Note: The token will be visible only upon creation. It will no longer be visible after the user closes the box below.
If a user needs to delete an API token once it is created, the user should return to the API Token tab under integrations and click the trashcan icon next to the token. Note: If this API token is deleted, the created user will not be able to log in.