OpenAPI

A OpenAPI é uma especificação para descrever APIs REST. Usando especificação OpenAPI 2.0 é possível criar documentos da OpenAPI para as instâncias Communications para descrever a estrutura.

Isso permite que você faça o seguinte:

• Crie bibliotecas de cliente na sua linguagem preferida
• Criar stubs de servidor
• Usar ferramentas de gerenciamento de API

Estrutura básica de um documento do OpenAPI

Um documento da OpenAPI descreve a superfície de uma API REST. O documento define o nome e a descrição da API, os endpoints individuais (caminhos) na API, como os autores das chamadas são autenticados e muito mais.

Clique abaixo para ver um exemplo dessa estrutura básica.

JSON

    {
      "swagger": "2.0",
      "host": "businessmessages.googleapis.com",
      "info": {
        "title": "Business Messages API",
        "description": "",
        "version": "v1"
      },
      "paths": {
        "/v1/conversations/{conversationsId}/messages": {
          "post": {
            "description": "Sends a message from an agent to a user.",
            "parameters": [
              {
                "description": "Part of `parent`. Required. The conversation that contains the message. Resolves to \"conversations/{conversationId}\".",
                "type": "string",
                "in": "path",
                "required": true,
                "name": "conversationsId"
              },
              {
                "description": "Optional. A flag to send the specified fallback text instead of other message content.",
                "name": "forceFallback",
                "type": "boolean",
                "in": "query"
              },
              {
                "name": "message",
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "in": "body",
                "description": "Required. The content of a message."
              }
            ],
            "tags": [
              "businessmessages"
            ],
            "operationId": "CreateMessage",
            "responses": {
              "default": {
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "description": "Successful operation"
              }
            }
          }
        }
      }
    }
    

Para saber mais sobre a estrutura de um documento da OpenAPI, consulte a Site do Swagger.

Como acessar os documentos da OpenAPI

Para acessar os documentos da OpenAPI, você precisa ter uma chave de API de um Google Cloud Projeto da plataforma (GCP) com o Business Messages e o Business Communications APIs ativadas.

Siga as seções abaixo para

• criar um projeto do GCP
• criará uma Chave de API
• ativar as APIs Business Messages e Business Communications

Depois de concluir essas etapas, será possível acessar os documentos da OpenAPI.

Criar um projeto do GCP

Se você já tiver um projeto do GCP, use-o para criar uma chave de API.

Para criar um novo projeto do GCP, faça o seguinte:

1. Acesse Gerenciar recursos no console do GCP.
2. Na lista suspensa Selecionar organização na parte de cima da página, selecione a organização para a qual você quer criar o projeto. Se você é um usuário do teste sem custo financeiro, pule esta etapa.
3. Clique em Criar projeto.
4. Na janela New Project, insira um nome e selecione um conforme aplicável. Um nome de projeto só pode conter letras, números, aspas, hifens, espaços ou pontos de exclamação e deve ter entre 4 e 30 caracteres.

5. Em Local, insira a organização ou pasta pai do novo projeto.

6. Clique em Criar.

Criar uma chave de API

1. Acesse o Página de credenciais no console do GCP.

2. Clique em Criar credenciais e selecione Chave de API.

   A chave recém-criada será exibida na caixa de diálogo Chave de API criada. Copie sua chave e a mantenha em segurança. Para saber mais sobre as chaves de API, consulte Documentação da chave de API.

Ativar a API Business Communications e a API Business Messages

Para ativar essas APIs no seu projeto do GCP, faça o seguinte:

1. Acesse a página APIs e Serviços no console do GCP.
2. Na lista suspensa Selecionar projeto, selecione o projeto em que você quer ativar as APIs.
3. Clique em Ativar APIs e serviços.
4. No campo Search for APIs and Services, digite Business Messages.
5. Selecione API Business Messages.
6. Clique em Ativar.
7. Clique em Ativar APIs e serviços.
8. No campo Search for APIs and Services, digite Business Communications.
9. Selecione API Business Communications.
10. Clique em Ativar.

Agora sua chave de API tem permissões para acessar os documentos da OpenAPI para a as APIs Business Messages e Business Communications.

Acessar os documentos da OpenAPI

Execute este comando para acessar o documento da OpenAPI para a API Business Messages:

curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Execute este comando para acessar o documento da OpenAPI para a API Business Communications:

curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Substitua API_KEY pela sua chave de API.