An API Token allows approved third-party applications and integrations to securely access your FoodLogiQ account without requiring a user to log in interactively.
In this article:
Overview
API Tokens are commonly used when connecting FoodLogiQ to:
- ERP systems
- WMS platforms
- Business intelligence tools
- Custom integrations
- Integration partners and middleware providers
The token authenticates requests made to the FoodLogiQ API and inherits the permissions of the user who created it.
Important
Only users with the Generate API Token permission can create API Tokens. API Tokens provide the same access as the user account that created them. Carefully consider which account should be used when generating a token.
Generate an API Token
Step 1: Open Integrations
- Log in to FoodLogiQ.
- Select Settings.
- Choose Integrations.
Step 2: Create a New Token
- Select the API Tokens tab.
- Click Add API Token.
Step 3: Name the Token
Enter a unique name for the token.
Use a name that identifies:
- The integration partner
- The connected application
- The intended purpose
Examples:
- SAP Integration
- WMS Connector
- Power BI Reporting
- Product Data Export
Step 4: Copy the Token
After selecting Create, FoodLogiQ generates the API Token.
Note
The token is displayed only once. Copy and store it immediately in a secure location.
You may:
- Use the copy button to copy the token to your clipboard.
- Use the visibility icon to temporarily display the token.
Step 5: Configure the Integration
Provide the copied token to your integration partner or enter it into the third-party application that will connect to FoodLogiQ.
Configuration requirements vary by application.
Create a Limited-Access Integration Account
Step 1: Create a Role
- Navigate to User Management > Roles.
- Create a new role for the integration.
- Assign only the permissions required by the integration.
For example:
| Integration Type | Suggested Permissions |
|---|---|
| Data Export | Read-only access |
| Recall Response Integration | Recall and response permissions |
| Product Synchronization | Product management permissions |
| Reporting | Reporting and read access |
Step 2: Create a Service Account
- Create a new user account.
- Assign the integration-specific role.
- Use an email address dedicated to the integration.
Step 3: Generate the Token
Sign in as the service account and follow the token generation process above.
The resulting API Token will only have access to the permissions assigned to that account.
Delete an API Token
Deleting a token immediately prevents any future API requests from authenticating with that token. If an API Token is no longer needed:
- Navigate to Settings > Integrations.
- Open the API Tokens tab.
- Locate the token.
- Select the delete icon.
Troubleshooting
I forgot to copy the token.
API Tokens cannot be viewed again after the creation window is closed. Create a new token and update the integration with the new value.
The integration is receiving authorization errors.
Verify:
- The token was copied correctly.
- The token has not been deleted.
- The user account that created the token has the required permissions.
- The integration is using the correct FoodLogiQ environment.
Who can generate API Tokens?
Users with the Generate API Token permission enabled in their assigned role.