Configure Open API
Intel Exchange allows you to integrate with other applications using the REST API protocol. To integrate with other applications and access the features using an API, you must have the appropriate API credentials for secure information exchange. Open API enables you to generate and manage the API credentials to authorize information exchange. The API credentials are a combination of API URL, Access ID, and Secret Key.
Generate Open API Credentials
You can generate open API credentials to integrate Intel Exchange into third-party applications.
Before you Start
Ensure that you have Create and Update permissions for CTIX Integrators.
Steps
To generate the open API credentials, follow these steps:
Go to Administration > Integration Management.
In Third Party Developers, click CTIX Integrators.
Click Add New. Enter the following details:
Name: Enter a unique name for the API credentials in 50 characters.
Description: Enter a description for the credentials within 1000 characters.
Expiry Date: Select an expiry date for open API keys. To apply an expiration date for the credentials, you can select Expires On and select the date. To ensure the credentials never expire, you can select Never Expire.
Click Add New.
Click Download to download the API credentials in CSV format. You can also click Copy to copy the endpoint URL, secret key, and access ID.
Important
It is recommended to download the API credentials since you cannot recover the credentials later.
To make an API request to Intel Exchange, you must create a signature using the Access ID and Secret Key of the API credentials with an expiry time. For more information, see CTIX API Reference.
Manage Open APIs
In the CTIX Integrators listing, you can view all the open API credentials that are created in Intel Exchange.
Search and filter: You can search and filter APIs based on status, created range, created by, expiry range, and last accessed date range.
Logs: You can view the activity logs of the API.
Edit: You can edit the details of an API, such as name, description, and expiry date.
Delete: You can delete the API credentials. Before deleting, ensure that the credentials are not used in any integrations or open API workflows to prevent disruptions.
Customize View: You can customize the API table to hide or unhide a column and reorder the columns.
Update Open API
You can update an open API to update the details or set the status to active or inactive the API.
Before you Start
Ensure that you have Create and Update permissions for CTIX Integrators.
Steps
To update Open API credentials, follow these steps:
Go to Administration > Integration Management.
Click CTIX Integrators under Third Party Developers.
Select the title of an API credential, click the vertical ellipses, and click Edit.
Update the name, description, or expiry date and click Save.
You will be notified when the credentials details are updated.
Best Practices for Open API Credentials
Follow these best practices to prevent disruptions while using open API credentials in Intel Exchange:
Enable Expiry Notifications: If your API credentials have an expiry date, select the Notify me before the expiration date checkbox to receive reminders before they expire. You can configure notifications in Configurations. For more information, see Configure System Notifications. After expiry, the credentials will cease to work in any service or application where it is used.
Maintain a Usage Log: It is recommended to keep a local record of where your open API credentials are used. This helps you track dependencies and manage open API-related workflows effectively.
Communicate Credential Resets: If you reset any API credentials, inform your team to prevent disruptions in any integrations, applications or services relying on them.
Verify Usage Before Deleting: Ensure that API credentials are not in use before deleting them to avoid any potential disruptions in integrations or workflows.