API Endpoints are characterized as either Consumer or Provider Endpoints. API Consumer Endpoints are automatically created in the CIC Cockpit when Web Service Consumer objects are created in CIC Studio and deployed to the Integration Server. API Provider Endpoints are created in CIC Cockpit and represent the APIs that can be consumed by the user of this endpoint.
Both Endpoint types reflect API requests and responses in your integration. The details of these messages and responses can be viewed from the CIC Cockpit.
Any integration using these Endpoints is driven by the Integration Engine and CIC Studio. API Endpoints are not available to be used in Data Flows in the CIC Cockpit. They are, however, used by CIC Cockpit to display Job information on the Job List page and Job Details page.
API Consumer Endpoints
API Consumer Endpoints (shown below) are auto-generated in the CIC Cockpit when Web Service (WS) Consumer objects are created in CIC Studio and deployed to the Integration Server. Multiple WS Consumer objects referencing the same host and vault alias value (if applicable) are combined into a single API Consumer Endpoint, which can be viewed from the Jobs page.
Changes to API Consumer Endpoints in the CIC Cockpit are limited to renaming only. This type of Endpoint cannot be created or deleted directly from the CIC Cockpit.
API Provider Endpoints
You create API Provider Endpoints in the CIC Cockpit when Web Service (WS) Provider objects have been created in CIC Studio and deployed to the Integration Server.
API Provider Endpoint Attributes
The API Provider Endpoint has the following attributes:
|APIs||Displays a list of the APIs selected for this Endpoint.
If no APIs have been selected, the Select APIs link is displayed. Click the link to see a list of APIs you can choose from.
If a list of APIs is displayed, you can click the Edit button to add or remove APIs from the list.
Each line item in the APIs list shows the API name and authentication method. If the authentication method is OAuth2, the Access Token URL field contains the address you would use to obtain an access token. See Using OAuth2 with API Endpoints. The Access Token URL field does not contain any value for an API using Basic Authentication.
|Authentication||Displays the type of authentication employed for the APIs listed above. The authentication type is defined as part of the API itself. Possible types are Basic, OAuth2, Key-based, and Custom. See Using Basic Authentication with API Endpoints, Using OAuth2 with API Endpoints, or Using Key-based Authentication in API Endpoints.|
Creating an API Provider Endpoint
- Click the New Endpoint icon on the Endpoint screen.
- Specify a Name and select API as the Endpoint Type.
- Click the Select APIs link to display a list of available APIs and select one or more APIs to associate with this Endpoint.
- Specify Authentication attribute values for your Endpoint. See Using Basic Authentication with API Endpoints, Using OAuth2 with API Endpoints, or Using Key-based Authentication in API Endpoints.
- Click Save.
Troubleshooting API Issues
When a failure occurs in the CIC Engine, it creates a ticket in ZenDesk or CIC, depending on how CIC is configured. Specifically, when an API fails, the ticket includes a hyperlink to the CIC Cockpit Job Details view which corresponds to the failed Job.
Additional details are also added to the ticket:
- Response Status Code
- Response Status Message
- Response Payload
- Web Service Provider/Consumer that was initiated
- Source & Target Endpoint
- Trading Partner, if configured.
This information will be available on the failed Job view, Zendesk ticket, and Email notification as well.
The title of the ticket or the subject of the Email notification is also customized so that users can identify the context of the failure.
For larger payloads, the payload is partially displayed in both the email and zendesk ticket; the full message can be downloaded from the Job view. Users can navigate to the Job view by clicking the View Job button.
In case of unsupported payload content type, the payload can be downloaded as a full message from the Job view. Users can navigate to the Job view by clicking the View Job button.
Note: The above information in the Ticket/Email Notification requires the latest CIC Engine and CIC Studio version (v5.x or later in case of older generation CIC). These details are only available for tickets generated after February 9th, 2023.
Please sign in to leave a comment.