Quick Start

See which APIs are available to Application Developers with the REST API for the Developer Portal in Oracle API Platform Cloud Service by performing the following tasks.

Step 1: Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to access the Developer Portal. Specifically, you will need:

• Username and password

• The Application Developer role in Oracle API Platform Cloud Service or membership to a group assigned the Application Developer role

  Note: If you are performing administration tasks, like updating the Developer Portal configuration or adding language resources, you must have the Administrator role.

Step 2: Install cURL

The examples within this document use the cURL command-line tool to demonstrate how to access the REST API for the Developer Portal in Oracle API Platform Cloud Service.

To connect securely to the server, you must install a version of cURL that supports SSL and provide an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. For more information about:

• Using cURL, see Use cURL.

• Authentication, see Authentication.

The following procedure demonstrates how to install cURL on a Windows 64-bit system.

1. In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.

2. On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.

3. Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the cacert.pem SSL CA certificate bundle in the folder where you installed cURL.

4. Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate bundle. For example:

   C:\curl> set CURL_CA_BUNDLE=cacert.pem

You are now ready to send requests to the REST API for the Developer Portal in Oracle API Platform Cloud Service using cURL.

Step 3: View Available APIs

The following cURL example returns all APIs that the user can view that have been published to the Developer Portal.

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/developers/v1/apis

The following sample response body lists the APIs the client can see in the Developer Portal, including their state (Released, Alpha, and Beta), which applications are registered to them, and HATEOAS links for related operations.

{
  "count": 3,
  "filters": [
    "REGISTERED"
  ],
  "hasMore": false,
  "items": [
    {
      "type": "api",
      "id": 180,
      "links": [
        {
          "href": "https://example.com/apiplatform/developers/v1/apis",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        },
        {
          "href": "https://example.com/apiplatform/developers/v1/apis/WeatherService",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        }
      ],
      "name": "WeatherService",
      "plans": [
        {
          "description": "default",
          "id": 168,
          "links": [],
          "name": "WeatherService",
          "registeredApps": [
            {
              "id": 345,
              "name": "WeatherApp 1",
              "state": "REGISTERED"
            }
          ]
        }
      ],
      "state": "ALPHA",
      "vanityName": "WeatherService",
      "version": "1"
    },
    {
      "type": "api",
      "description": "Credit Check",
      "id": 211,
      "links": [
        {
          "href": "https://example.com/apiplatform/developers/v1/apis",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        },
        {
          "href": "https://example.com/apiplatform/developers/v1/apis/CreditCheck",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        }
      ],
      "name": "CreditCheck",
      "plans": [
        {
          "description": "default",
          "id": 181,
          "links": [],
          "name": "CreditCheck 1",
          "registeredApps": []
        }
      ],
      "state": "ALPHA",
      "vanityName": "CreditCheck",
      "version": "1"
    },
    {
      "type": "api",
      "id": 152,
      "links": [
        {
          "href": "https://example.com/apiplatform/developers/v1/apis",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        },
        {
          "href": "https://example.com/apiplatform/developers/v1/apis/SportsScores",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        }
      ],
      "name": "SportsScores",
      "plans": [
        {
          "description": "default",
          "id": 148,
          "links": [],
          "name": "SportsScores 1",
          "registeredApps": []
        }
      ],
      "state": "BETA",
      "vanityName": "SportsScores",
      "version": "1"
    }
  ],
  "limit": 0,
  "links": [
    {
      "href": "https://example.com/apiplatform/developers/v1/apis",
      "method": "GET",
      "rel": "canonical",
      "templated": "true"
    }
  ],
  "offset": 0,
  "states": [
    "RELEASED",
    "ALPHA",
    "BETA"
  ]
}