OpenAPI

OpenAPI es una especificación para describir las API de REST. Con la especificación de OpenAPI 2.0, puedes crear documentos de OpenAPI para las API de Business Messages y Business Communications a fin de describir su estructura.

Esto te permite hacer lo siguiente:

  • Crea bibliotecas cliente en tu lenguaje preferido
  • Crea stubs de servidores
  • Usa herramientas de administración de API

Estructura básica de un documento de OpenAPI

Un documento de OpenAPI describe la superficie de una API de REST. El documento define el nombre y la descripción de la API, los extremos individuales (rutas de acceso) en la API, cómo se autentican los emisores y mucho más.

Haga clic a continuación para ver un ejemplo de esta estructura 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 obtener más información sobre la estructura de un documento de OpenAPI, consulta el sitio web de Swagger.

Cómo acceder a los documentos de OpenAPI

Para acceder a los documentos de OpenAPI, debes tener una clave de API de un proyecto de Google Cloud Platform (GCP) con las API de Business Messages y Business Communications habilitadas.

Sigue las secciones que aparecen a continuación para

  • crear un proyecto de GCP
  • creará una clave de API
  • habilitar la API de Business Messages y la API de Business Communications

Una vez que completes estos pasos, podrás acceder a los documentos de OpenAPI.

Crea un proyecto de GCP

Si ya tienes un proyecto de GCP, puedes usarlo para crear una clave de API.

Para crear un proyecto de GCP nuevo, haz lo siguiente:

  1. Navega a la página Administrar recursos en GCP Console.
  2. En la lista desplegable Seleccionar organización, en la parte superior de la página, selecciona la organización para la que deseas crear el proyecto. Si eres un usuario de prueba gratuita, omite este paso.
  3. Haz clic en Crear proyecto.
  4. En la ventana Proyecto nuevo, ingresa un nombre de proyecto y selecciona una cuenta de facturación según corresponda. El nombre de un proyecto solo puede contener letras, números, comillas simples, guiones, espacios o signos de exclamación, y debe tener entre 4 y 30 caracteres.

  5. En Ubicación, ingresa la organización o carpeta superior para el proyecto nuevo.

  6. Haz clic en Crear.

Crear una clave de API

  1. Dirígete a la página Credenciales en GCP Console.

  2. Haz clic en Crear credenciales y, luego, selecciona Clave de API.

    Se mostrará la clave nueva en el cuadro de diálogo Se creó la clave de API. Copia tu clave y mantenla segura. Para obtener más información sobre las claves de API, consulta la documentación sobre las claves de API.

Habilita la API de Business Communications y Business Messages

Para habilitar estas API en tu proyecto de GCP, haz lo siguiente:

  1. Ve a la página API y servicios en GCP Console.
  2. En la lista desplegable Seleccionar proyecto, selecciona el proyecto para el que deseas habilitar las API.
  3. Haga clic en Habilitar API y servicios.
  4. En el campo Buscar API y servicios, ingresa Business Messages.
  5. Selecciona API de Business Messages.
  6. Haz clic en Habilitar.
  7. Haga clic en Habilitar API y servicios.
  8. En el campo Buscar API y servicios, ingresa Business Communications.
  9. Selecciona API de Business Communications.
  10. Haz clic en Habilitar.

Ahora tu clave de API tiene permisos para acceder a los documentos de OpenAPI para las API de Business Messages y Business Communications.

Accede a los documentos de OpenAPI

Ejecuta este comando para acceder al documento de OpenAPI para la API de Business Messages:

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

Ejecuta este comando a fin de acceder al documento de OpenAPI para la API de Business Communications: 

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

Reemplaza API_KEY por tu clave de API.