OpenAPI

OpenAPI es una para describir las APIs de REST. Usando Especificación de OpenAPI 2.0, puedes crear documentos de OpenAPI para Business Messages y Business las APIs de Communications para describir su estructura.

Esto te permite hacer lo siguiente:

  • Crea bibliotecas cliente en tu lenguaje preferido.
  • Crea stubs de servidor
  • Usa herramientas de administración de APIs

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 cómo se autentican los emisores, entre otros.

Haz clic a continuación para ver un ejemplo de esta estructura básica.

    {
      "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 desde un de Google Cloud con las funciones Business Messages y Business Communications Se habilitaron las APIs.

Sigue las secciones 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 Administrar recursos en la consola de GCP.
  2. En la lista desplegable Seleccionar una organización, que se encuentra en la parte superior de la página. selecciona la organización para la que quieres crear el proyecto. Si usas la prueba gratuita, omite este paso.
  3. Haz clic en Crear proyecto.
  4. En la ventana New Project, ingresa un nombre para el proyecto y selecciona una cuenta de facturación según corresponda. El nombre de un proyecto solo puede contener letras, números, comillas, 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 del proyecto nuevo.

  6. Haz clic en Crear.

Crea una clave de API

  1. Ve a la sección Página Credenciales en la consola de GCP.

  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 protégela. Para obtener más información sobre las claves de API, consulta la Documentación de la clave de API.

Habilita la API de Business Communications y la API de Business Messages

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

  1. Consulta la página de APIs y de Google Cloud en la consola de GCP.
  2. En la lista desplegable Seleccionar proyecto, selecciona la proyecto para el que quieres habilitar las APIs.
  3. Haz clic en Habilitar APIs y servicios.
  4. En el campo Buscar APIs y servicios, ingresa Business Messages.
  5. Selecciona API de Business Messages.
  6. Haz clic en Habilitar.
  7. Haz clic en Habilitar APIs y servicios.
  8. En el campo Buscar APIs y servicios, escribe 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 del APIs 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 para 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.