API Access
The API Access section allows you to create and manage authorization keys required to authenticate and interact with iClear services.
The API Access section allows you to create and manage API IDs and tokens to access services within iClear.
To view the list of available API Access records or to create a new one, go to the API Access section.
Use this section to:
- Group API access records based on service categories.
- Filter API access records by name, status, service, and category to quickly locate the specific records you need.
- Create new API access records, or view, edit, or delete API tokens for secure access.
You can filter the list of available API Access records by name, status, the services to which API access is granted, and service category.
Read more about iClear Services in this article.
The list of API Access records is grouped by service category and includes information such as the record name, service, status, date and time, API ID, and corresponding API token.
To create an API Access record, click the New API Access button. In the pop-up window, fill in the following data fields:
- Service: Select the iClear service for which you need API access.
- Name: Enter the name of the API Access.
Click the Save button to save the record.
To edit an existing API Access record, click the Edit button in the Actions column.
Note: You can’t edit the service at this stage.
To delete the API Access settings, click the Delete button in the Actions column. Then click the Yes button to confirm.
To change the API token, click the Change API Token button in the Actions column. Then click Yes in the pop-up window to confirm.
To get API documentation, click the Doc button in the Actions column, and you will be redirected to the API Documentation page.
You can also export information about available API access records to a CSV file by clicking the Export to CSV button.