When integrating with an API, especially if it involves user accounts or authentication, there are occasions where synchronization of authorization is necessary. Here's why and when it might be needed:
- Adding API Token: When you add a new API token to FBO One for accessing an API, the authorization mechanism requires synchronization. This synchronization ensures that the new token is recognized and authorized by the API provider.
- Modifying API Integration: If you make changes to an existing API integration, such as updating scopes, permissions, or other settings related to authentication, synchronization may be required. This ensures that the changes are reflected in the authorization process and that the integration continues to work as expected. e.g adding a new FBO Location role access to the API.
- Token Expiration and Renewal: API tokens often have expiration dates for security reasons. When a token expires, it needs to be renewed or replaced with a new token. Synchronization ensures that the application recognizes the new token and can continue to access the API without interruption.
- User Account Changes: If there are changes to user accounts that are linked to the API integration, such as role changes, account deletions, or updates to user permissions, synchronization may be necessary to reflect these changes in the authorization process.
Note: Access to the pages in the following steps will be restricted to approved Users. If you need assistance, please contact your designated FBO One system administrator. If you believe there is a technical issue with the API, please raise a request to notify the FBO One support team.
Steps:
- Navigate to the 'Users' page.
- 'Select' the API User account. This will be the user account setup to access the API during integration. Each API integration will have its own User.
- Scroll down to the 'Public API Information' section.
- Confirm the API Token details are present and that the API 'Expire' date has not passed.
- Select 'Sync Authorisation'
- NOTE: If there is an issue encountered during sycronization, an error will be displayed. Refresh the page and retry. If the issue persists, please confirm the token details are correct with your API Integration partner support.
- Test any changes that have been made to confirm the Integration is behaving as expected. Depending on the integration and frequency of updates, it could take several minutes to see the change take affect.
Comments
0 comments
Article is closed for comments.