Manage contracts for apps that are connected to your API.
You can review the status of your API's connections, including pending and active API access requests, in the My APIs > API > Apps page. This page provides a high level summary of workflow status for apps with current API access contracts or pending API access requests for the current API.
Each listing includes:
The following tables provide explanations for information you might see on this page.
Contract Status | Description |
---|---|
Access Requested | An App has requested access to an API but the request has not been approved and activated in the Sandbox or Production environment. |
Active | API Access has been approved and activated. |
Inactive | API access has not yet been requested. |
Rejected | The API Access Request has been rejected. |
Suspended | API Access that was previously active has been suspended. |
App Management Task | Description |
---|---|
Cancel | Cancels an API Access Request. Listing is removed from the API Connections page. Requestor must submit another request to initiate the process again. |
Suspend | Suspends the API Access Request. This action can only be performed when the request status is Active. |
Resume | Resumes the API Access Request and changes the request status to Active after it has been suspended. |
API Access Request Task | Description |
---|---|
Approve | Approves the API Action Request. Note that the request still requires activation after it has been approved. |
Reject | Rejects the API Action Request. |
Cancel | Cancels the API Action Request. Requestor must submit another request to initiate the process again. |
Activate | Activates the API Access Request. |
Suspend | Suspends the API Access Request and is performed after the request has been activated. |
Resume | Resumes the API Access Request and puts it into an activated state after it has been suspended. |
When a contract that an app has with your API is approved and/or activated, you can still revise the contract to modify the licenses or make other changes as needed.
When you revise an active contract, the platform creates a new contract based on the existing one. You can then modify the properties as needed. When the new contract is activated, the original version is automatically cancelled, and the new contract becomes the active contract. There is no interruption of traffic for the contract, and the metrics for the contract continue to increment.
You can export all the API contracts for your API when you export the API via the Export button on the API Details page (see How do I export an API?).
However, you might want to export a specific contract. You can do that via the My APIs > API > Apps page, where you can view the contracts for all apps that are connected to your API.
The API contract export file includes all the core information about the API/app contract, as well as any of the optional additional information you specified.
The export file will generally include the following: