Saiba mais sobre as APIs REST do Oracle API Platform Cloud Service

O Oracle API Platform Cloud Service fornece web services REST que você pode usar para automatizar determinadas tarefas.

As APIs REST incluídas no Oracle API Platform Cloud Service são:

  • Serviço de Administração: Fornece operações para gerenciar artefatos de gateway, criar e obter informações de política, obter e atualizar preferências do usuário e obter informações sobre atribuições e concessões para usuários, entre outras operações administrativas.
  • Análise: Fornece operações para obter estatísticas e informações de desempenho, como aplicativos ativos, falhas, número total de solicitações, gateways ativos, solicitação e resposta como dados de série de tempo etc.
  • Serviço ao Consumidor: Fornece operações que suportam a criação e a exclusão de aplicativos, ou atualiza informações do aplicativo, adiciona ou remove concessões a aplicativos, gerencia definições de configuração do portal do desenvolvedor, define ou exclui preferências do usuário, etc.
  • Controlador de Gateway: Fornece operações relacionadas à configuração de nós e perfis de segurança.
  • Serviço de Gerenciamento: Fornece operações para criar e implantar APIs, concessões de API, criar e gerenciar aplicativos, implantações e direitos de API entre outras operações.

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

Use a API de Gerenciamento do Oracle API Platform Cloud Service para Criar uma Nova API

Use a API de Gerenciamento do Oracle API Platform Cloud Service para criar APIs usando REST.

Para criar uma API usando a API REST de Gerenciamento, você pode usar o cURL ou o cliente REST de sua preferência para testar se tem a atribuição de Gerente de API antes de executar os comandos REST em seus scripts.

  1. Em um Editor, crie um modelo JSON básico para a solicitação cURL com as informações a seguir.
    {
        "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"]
            }
        }
    }

    No modelo JSON, name é o nome da sua API e version é a sua versão da API. Este modelo tem as informações essenciais mínimas necessárias para criar uma API no Oracle API Platform Cloud Service, como um nome de API, uma versão, as políticas de Solicitação de API e de Solicitação de Serviço no modo de rascunho e as políticas de Resposta de Serviço e Resposta 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 os cabeçalhos de resposta da solicitação e do corpo da resposta.
    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

    O corpo da resposta do servidor também está no formato JSON.

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