Configure Open API
Orchestrate 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.
To view the maximum allowed limit of Open APIs that you can create based on your license, go to Admin Panel > License Management.
Generate Open API Credentials
Before you Start
Your user group must have Create/Update permission for Open APIs.
Steps
To generate the open API credentials, follow these steps:
Go to Admin Panel > Open API.
Click Add Open API.
API Title: Enter a unique title for the Open API.
Expiration Date: Select Expires on and choose an expiry date for the Open API key. Choose Never Expire if you don't want the key to expire.
Note
You will receive email notifications before and after the Open API expires.
Toggle the status to Active.
Click Create.
Click Download Token to download the API credentials in CSV format. You can also click Copy to copy the API URL, Secret Key, or Access ID.
Important
Cyware recommends downloading the API credentials, as they cannot be recovered later.
To make an API request to Orchestrate, you must create a signature using the Access ID and Secret Key of the API credentials with an expiry time.
Manage Open APIs
On the Open API page, you can view all the open APIs that are created in Orchestrate. You can perform the following actions on the Open API listing page:
Update the required fields for an Open API. For example, toggle the status of an active Open API to Inactive.
Search for specific Open APIs.
Filter Open APIs based on specific criteria. For example, filter by Active Open APIs.
Sort the APIs based on the following criteria:
Modified
Created
Name
Expiry Date
Customize the API table to hide or unhide a column and reorder the columns.