PaaS - How to setup the Oracle API Platform Cloud Service (Part 1)

This blogpost covers how to setup the Oracle API Platform Service in the cloud. I will cover the installation and registration of the API Gateway in a separate post and also cover the creation and deployment of actual API's in another. 

There are pre-requisites before setting up Oracle API Platform Cloud Service. You must have the following Oracle Cloud Services already setup:

1. Oracle Storage Container (See blogpost here)
2. Oracle Cloud Database (See blogpost here)

1. Once logged into Oracle Cloud, from the Dashboard menu, click on the 'API Platform' option:

2. On the Oracle API Platform Cloud Service page, click 'Create Service':

3. Service - Provide basic service instance information:
Enter a Service Name and Description for your new API Platform.

SSH Public Key
This functionality ensures you are able to connect to the Cloud Instance externally using a private key. Click Edit:

You can either:
a) Browse and upload a public key file - ensure you have the respective private key already
b) Enter the text of the public key - ensure you have the respective private key alreadyc) 'Create a New Key' - The Oracle functionality generates a public and private key for you. In my example, I allow the page to create my Public key and I save the Private key locally: my example, my URL is: The username and password are the credentials of the user for that domain.

Once you have filled in all the fields, click 'Next':

4. Service Details - Provide details for your service:
Enter the configuration details for the new API Platform Service.

Database Configuration
The API Platform Service requires connection details to an Oracle Cloud Database. A list of existing Databases are available to select from from the first dropdown list. Enter the respective admin user (sys) and its password.

The 3 attributes under Weblogic are to create the new Administrator user and password. Make a note of these credentials after entering them. These credentials will be used throughout the lifetime of this instance, including when installing the API Gateway.

Backup and Recovery Configuration
For the Cloud Storage Container attribute, you must enter the URL to the specific Storage Container. The format for the URL is as follows:

Once all configuration details are entered, click Next.

5. Confirmation - Once you are satisfied after reviewing all the configuration, click Create.

Back on the Oracle API Platform Cloud Service page, you will see your instance of the API Platform with a Status of Creating Service... Go take a break as the creation of the API Platform Service will take around an hour! Oracle will send an email to the email address used for the Notification Email attribute once the API Platform is set up and running.

Once up and running, click on the name of the API Platform you have created:

On this page, you will see the topology related to the API Platform. Details such as IP's, the host machines where the API Platform is deployed and running (Weblogic servers), as well as information about the Load Balancer that is installed infront of the host machines.

Near the top of the page, click on the grey menu icon to get access to useful links such as the API Portal Console, Developer Portal Console etc. These destinations are where the fun starts with respect to managing the API Platform. 

Oracle API Portal Console
The management portal runs in the Oracle Public Cloud and is the heart of the Oracle API Platform Cloud Service. The management portal, along with Apiary (also running in the cloud) enables API First design and development of APIs. The gateway managers can create, manage, secure and publish APIs using the management portal. The APIs are deployed on to runtime gateways which enforce policies at runtime. The URL for the Management Portal is https://IP:PORT/apiplatform 

Oracle Developer Portal Console
After an API is published, API Consumers (application developers typically) use the Developer Portal to discover, register, and consume APIs. The Developer Portal can be completely customized to an enterprise’ needs so that they can publish it as their own portal to their customers. Developer Portal can also run either on the Oracle Cloud or directly in the customer environment on premises. The URL for the Developer Portal is https://IP:PORT/developers

API Gateway
API Gateways are the runtime components that enforce all policies specified through the management portal. Gateways also help in collecting data for analytics. The gateways can be deployed anywhere – on premise, on Oracle Cloud or to any third party cloud providers. This allows the gateways to be closest to your backend services. Some organizations may not want to expose their data at runtime through the cloud, so it is possible for them to deploy the gateway on premise. Their data is never published back to the cloud. For analytics also, only the aggregated information is passed back periodically to the management service running on the cloud.

API Gateway Installation
The next step will be to download and install the API Gateway. In my next blogpost, I will cover the installation of the API Gateway and will register it with the Oracle API Platform Cloud service we have created above: PaaS - How to install Oracle API Gateway and register with Oracle API Platform Cloud Service - Part 2.

1 comment:

  1. It is interesting to know how vast amount of data is stored and retrieved from the cloud. The whole process was explained clearly with the suitable example.
    Cloud Computing Courses | Cloud computing course in Chennai