Obtener información sobre las API de Oracle API Platform Cloud Service

Oracle API Platform Cloud Service proporciona servicios web REST que puede utilizar para automatizar determinadas tareas.

Las API de REST incluidas en Oracle API Platform Cloud Service son:

  • Servicio de administración: proporciona operaciones para gestionar artefactos de gateway, crear y obtener información sobre políticas, obtener y actualizar preferencias de usuario y obtener información sobre roles y permisos para usuarios, entre otras operaciones administrativas.
  • Análisis: proporciona operaciones para obtener estadísticas e información de rendimiento, como aplicaciones activas, fallos, número total de solicitudes, gateways activos, solicitud y respuesta como datos de serie temporal, etc.
  • Servicio al consumidor: proporciona operaciones que soportan la creación y supresión de aplicaciones, o actualiza la información de la aplicación, agrega o elimina permisos a las aplicaciones, gestiona los valores de configuración del portal del desarrollador, define o suprime las preferencias del usuario, etc.
  • Controlador de gateway: proporciona operaciones relacionadas con la configuración de nodos y perfiles de seguridad.
  • Servicio de gestión: proporciona operaciones para crear y desplegar API, permisos de API, crear y gestionar aplicaciones, despliegues y derechos de API entre otras operaciones.

The Management Service is a REST API that you can use to create and deploy APIs in Oracle API Platform Cloud Service.

Uso de la API de gestión de Oracle API Platform Cloud Service para crear una nueva API

Utilice la API de gestión de <span>API Platform Cloud Service</span>Oracle API Platform Cloud Service de Oracle para crear API mediante REST.

Para crear una API mediante la API de REST de gestión, puede utilizar cURL o el cliente REST de su preferencia para probar que tiene el rol API Manager antes de ejecutar los comandos REST en sus scripts.

  1. En un editor, cree una plantilla JSON básica para la solicitud de cURL con la siguiente información.
    {
        "name": "YOUR_API_NAME",
        "version": "YOUR_API_VERSION",
        "implementation":
        {
            "policies": [
            {
                "id": "1",
                "type": "o:ApiRequest",
                "version": "1.0",
                "draft": true,
                "config":
                {}
            },
            {
                "id": "2",
                "type": "o:ServiceRequest",
                "version": "1.0",
                "draft": true,
                "config":
                {}
            },
            {
                "id": "3",
                "type": "o:ServiceResponse",
                "version": "1.0",
                "config":
                {}
            },
            {
                "id": "4",
                "type": "o:ApiResponse",
                "version": "1.0",
                "config":
                {}
            }],
            "executions":
            {
                "request": ["1", "2"],
                "response": ["3", "4"]
            }
        }
    }

    En la plantilla JSON, name es su nombre de API y version es su versión de API. Esta plantilla tiene la información esencial mínima necesaria para crear una API en Oracle API Platform Cloud Service, como un nombre de API, una versión, las políticas de solicitud de API y solicitud de servicio en modo de borrador y las políticas de respuesta de servicio y respuesta de API.

  2. By using cURL or your REST client, make a POST request to the https://YOUR-API-PCS-INSTANCE-URL/apiplatform/management/v1/apis endpoint, where YOUR-API-PCS-INSTANCE-URL is the URL of your Oracle API Platform Cloud Service instance.
  3. Verifique las cabeceras de respuesta de la solicitud y el cuerpo de respuesta.
    HTTP/1.1 200 OK 
    Server: Oracle-Traffic-Director/12.2.1.0.0
    Date: Tue, 19 Jul 2016 13:27:08 GMT
    Content-Length: 30
    Content-Type: application/json
    X-oracle-dms-ecid: dd439614-7d4f-47ad-a1ea-a25a74ec9403-0000032d
    X-oracle-dms-rid: 0:1
    Via: 1.1 otd_opc
    Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

    El cuerpo de respuesta del servidor también está en formato JSON.

    {
      "id": "101",
      "iterationId": "1"
    }