Go to the latest v7.6 documentation →
This session gives an admin pro-user the details of API Tokens of different Scenarios. An admin can perform the following actions such as Copy, Change Expiry Date, Activate, DeActivate, History, and Re-generate an API Token. Apart from this, the user can also Migrate an old API to a new API.
To learn about API Tokens tile, let us walk through the below procedure:
- Click the ‘ADMIN CONSOLE’ tab.
- Hover on the left-hand side of the application to view available options.
- Click the ‘System Preferences’ option.
Path: ADMIN CONSOLE > System Preferences
- Now the user can view the ‘Preferences’ page.
- Under the ‘Preferences’ page, a couple of tiles are displayed.
- Click the ‘API Tokens.’
- An ‘API Tokens’ session page is displayed.
- Below the API Tokens text, the user can view the detailed information of Scenario, Scenario Name, API, Expiry Date, Status, Created By, Created On, Modified By, and Modified On column names.
Note: To perform any operation (Copy, Change Expiry Date, Activate, De-Activate, History, Regeneration Token, and Migrate old API to new API) for the selected Scenario, it is mandatory to select one Scenario. This can be done by clicking the Scenario checkbox option. The application allows selecting only one Scenario checkbox at a time.
Path: ADMIN CONSOLE > System Preferences > API Tokens
- Checkbox the first Scenario (BDV-MS SQL JDBC) and hover on the ‘Copy’ icon.
- A message ‘Text copied to clipboard’ is displayed on the top right corner of the page.
- Hover on the second icon (Change Expiry Date) and click on it.
- A ‘Change Expiry Date’ pop-up window is displayed.
- The user can view two radio button options namely ‘Never Expires’ and ‘Expiry Date.’
Note: By default, the Never Expires option is selected.
- Clicking the ‘Expiry Date’ option displays a calendar, from where the user can choose a date of his/her choice.
- Click the ‘Save & Close’ button to save the updated changes.
- A message ‘Token Saved successfully’ is displayed on the top right corner of the page.
- The Expiry Date column against the selected Scenario is updated with the set date accordingly.
- Hover on the third icon (Activate).
- Clicking the ‘Activate’ icon displays a message “Token Activated Successfully” on the top right corner of the page.
- Hover on the fourth icon (DeActivate).
- Clicking the ‘DeActivate’ icon displays a message ‘Token De-Activated successfully’ on the top right corner of the page.
- Hover on the fifth icon (History).
- Clicking the ‘History’ icon button displays ‘Api Execution History’ pop-up window.
- Hover on the sixth icon (Re-generate token).
- Clicking the ‘Re-generate token’ icon displays ‘Are you sure to re-generate token?’ pop-up window.
- Click the ‘Re Generate’ button.
- A message ‘Token Re-generated successfully’ is displayed on the top right corner of the page and a ‘Copy New Api Url’ pop-up window is displayed on the page.
- A ‘Copy to clipboard’ button is used to copy the ‘Copy New Api Url’.
- Select the first Scenario (BDV-MS SQL JDBC) and click the ‘Migrate the old API to the new API’.
- A ‘Migrate old API to new API’ pop-up window is displayed where the user is supposed to enter the old API URL in the text box provided and then select either GET/POST method from the drop-down list.
- Click the ‘Generate new API’ button to generate and migrate to the new API.
- Click the ‘Refresh’ icon to refresh the ‘API Tokens’ session page.
- Click the ‘Menu’ button to navigate back to the ‘System Preferences’ session page.