OCI API Gateway for REST & SOAP Integrations
In this post, we will be touching up on a high-level as to what is OCI API Gateway and then in depth as to how you can use OCI API Gateway as front-end for your OIC Integrations.
What is API Gateway ?
In simple terms, API Gateway acts as a frontend to your applications so that your application endpoint can be hidden, as clients/third-party will be hitting on your API Gateway endpoint rather than your application.
Apart from this there are lot of other features in OCI API Gateway viz.,
- Payload Transformation
- Dynamic Routing
- Header & Query String Validation
- Rate Limiting
- Request/Response transformation
- Response Caching
- Public or Private Endpoints
- Creating your Open API-Loading into API Gateway and deploying it.
- Custom Authorization
- Connecting logs with OCI Logging Analytics
Deploying OIC Integrations on to OCI API Gateway
I) OIC REST Integrations on to OCI API Gateway
Before starting to deploy your OIC REST Integration on to API Gateway, you need to configure API Gateway in OIC.
For this, login to OIC console → Settings → Integrations → API Management. In here, you have to choose API Gateway (radio button) and populate data in the fields
a. Tenancy OCID (which is the OCID of your tenancy)
b. User OCID (which is OCID of the user with which you have logged into OCI Console)
c. Finger Print (which need to be generated in OCI Console → Identity & Security → Users → User Details (of your user) → API Keys → Add API Key)
d. Private Key
e. Pass Phrase (this is optional)
Once you populate these details and save a connection is established from OIC to OCI Gateway.
From now-on whenever you try activating an integration you’ll get an option “Activate & Deploy” which activates the integration. Along with this a window will pop-up asking you to choose the compartment on which your API Gateway is deployed along with choosing your API Gateway.
This deploys your OIC REST Integration on to selected OCI API Gateway.
The other way to deploy your already activated integrations on to OCI API Gateway is by choosing API Management from the hamburger menu against your already Activated Integration and choosing Compartment, API Gateway.
II) OIC SOAP Integrations on to OCI API Gateway
OCI API Gateway does support SOAP Integrations as well, but only as pass through. For SOAP Integrations OCI API Gateway you will not be able to avail the options like Transformations, Validations, etc.
For SOAP Integrations, we can create a deployment on OCI API Gateway manually. In the Routes of OCI API Gateway Deployment you need to choose Method → POST, Type → HTTP and in the backend URL you’ll have to provide the endpoint of your SOAP Integration rather than the WSDL and save changes.
For testing the SOAP deployments from Postman you’ll be adding Route Path to the API Gateway Deployment endpoint. Along with this you need to pass your OIC Credentials and payload in Body as raw XML and test it.
Postman testing procedure remains the same for REST Integrations as well, except populating data for Body. For REST Integrations we’ll be passing credentials under Authorization and query parameters under Params
NOTE: You can learn more about OCI API Gateway here
