Send Requests

Use the following guidelines when sending requests using the REST API for the Consumer Service in Oracle API Platform Cloud Service - Classic.

URL Structure

Access the Consumer Service REST resources using the following URL structure:
https://<subdomain>.<domain>.com:<port>/developers/services/v1/<resource-path>
Where:
  • <subdomain.domain>.com:<port> ? Host and port where the Oracle API Platform Cloud Service - Classic Developer Portal is running.

  • <resource-path> ? Relative path that defines the resource.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about a resource.
POST Add information for or update a resource.
DELETE Delete information associated with a resource.

Media Types

The following media types are supported by the REST API for the Consumer Service in Oracle API Platform Cloud Service - Classic:

  • application/json

Supported Headers

The REST API for the Consumer Service in Oracle API Platform Cloud Service - Classic supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Content-Type

Media type of the body of the request. Required for POST and PUT requests.

Content-Type: application/json
Authorization

How to validate the user. See Security, Authentication and Authorization.

Authorization: Basic abcvZTphYmMxMjM=