Manage OIC Instance Services Using REST APIs

OIC REST APIs 

APIs

Oracle provide a number of API which can be use to manage the OIC (Oracle Integration Cloud) instance itself.  These API provide details about everything about the OIC integrations there connections and also current status.

These API as an Administrator allow you to manage your OIC instance very much from outside.

Prerequisite : 

1. OIC Instance 

Must have an OIC instance with  at lest developer level access.

Please sign in to your instance and see the url  it should be something like this.  Just keep this domain name handy as we need this in all our APIs.

https://<Domain Name>/ic/integration/home/faces/link

2. Postman: 

I am using this tool to fire REST APIs and getting the response back, but SOAPUI can also be used. Postman is more user friendly and have more options compare to SOAPUI for REST API. But again if you are good with SOAPUI then no compulsion to install Postman.

APIs

1.   Integrations :  

   If you want to know all your integrations in your OIC instance just use this API.  It give the full response about all the OIC integration in your OIC instance.  This require basic authentication in postman you can give same same as given below.

Now use this GET API to get information about all integrations

GET https://<Domain Name>/ic/api/integration/v1/integrations


Response:

 Response here will be detailed, It give connection been used for each of the integration and there end point details and status, package, pattern etc.


2. Connections 

This API provides all the connection which is available in OIC instance. It again require simple authentication which is been provided in point 1.

GET https://<Domain Name>/ic/api/integration/v1/connections


It provide details about each connection been created in OIC instance, its status and everything including end point. Using this end point which is again a REST API can drive details specific about this connection.

3.   Integration Details.

 
   Integration API in point 1 provide and end point for each and every integration you can use same of can built it yourself to get the details about the individual integration.

GET https://<Domain Name>/ic/api/integration/v1/integrations/<your integration ID>%<CurrentVersion of integration>


Details here are very much same as given for all integration in point 1. But here details are specific for single integration.



4. Integration Status 

 If you want to check integration status of any specific integration then use this API to know the current status of the integration

GET https://<DomainName>/ic/api/integration/v1/integrations/<Integration%Version>/activationStatus

Again if you get any difficulty in creating this API use URL from point 1 and add activationStatus to it.

Response will be :

 {   "activationStatus": "ACTIVATED"}

Its shows that activation status ACTIVATED mean integration process is already activated.



5. Changing Activation Status.

 This rest API provide integration status to change to activate or configure back.

POST https://<DomainName>/ic/api/integration/v1/integrations/<Integration%Version>/

BODY {   "activationStatus": "ACTIVATED"}


If there is no issue in your integration then it will activate the version given in the URL.  You can again check the status by using the API given in point 4.


There are further more REST APIs, we will check them in our next blog.  Please don't hesitate to provide your feedback good or bad. I am thankful for both.