OpenAPI

OpenAPI — это спецификация для описания REST API. Используя спецификацию OpenAPI 2.0 , вы можете создавать документы OpenAPI для API-интерфейсов Business Messages и Business Communications, чтобы описать их структуру.

Это позволяет сделать следующее:

  • Создавайте клиентские библиотеки на предпочитаемом вами языке
  • Создание серверных заглушек
  • Используйте инструменты управления API

Базовая структура документа OpenAPI

Документ OpenAPI описывает поверхность REST API. Документ определяет имя и описание API, отдельные конечные точки (пути) в API, способ аутентификации вызывающих абонентов и многое другое.

Нажмите ниже, чтобы увидеть пример этой базовой структуры.

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"
              }
            }
          }
        }
      }
    }

Чтобы узнать больше о структуре документа OpenAPI, посетите веб- сайт Swagger .

Как получить доступ к документам OpenAPI

Чтобы получить доступ к документам OpenAPI, у вас должен быть ключ API из проекта Google Cloud Platform (GCP) с включенными API-интерфейсами Business Messages и Business Communications.

Следуйте разделам ниже, чтобы

  • создать проект GCP
  • создать ключ API
  • включить API бизнес-сообщений и API бизнес-коммуникаций

Выполнив эти шаги, вы сможете получить доступ к документам OpenAPI .

Создать проект GCP

Если у вас уже есть проект GCP, вы можете использовать его для создания ключа API .

Чтобы создать новый проект GCP, выполните следующие действия:

  1. Перейдите на страницу « Управление ресурсами » в консоли GCP.
  2. В раскрывающемся списке Выберите организацию в верхней части страницы выберите организацию, для которой вы хотите создать проект. Если вы являетесь пользователем бесплатной пробной версии, пропустите этот шаг.
  3. Щелкните Создать проект .
  4. В окне « Новый проект» введите имя проекта и выберите учетную запись для выставления счетов. Имя проекта может содержать только буквы, цифры, одинарные кавычки, дефисы, пробелы или восклицательные знаки и должно содержать от 4 до 30 символов.

  5. В поле Location введите родительскую организацию или папку для нового проекта.

  6. Щелкните Создать .

Создать ключ API

  1. Перейдите на страницу учетных данных в консоли GCP.

  2. Нажмите «Создать учетные данные » и выберите «Ключ API ».

    В диалоговом окне создания ключа API отображается только что созданный ключ. Скопируйте свой ключ и сохраните его в безопасности. Дополнительные сведения о ключах API см. в документации по ключам API.

Включить API бизнес-коммуникаций и API бизнес-сообщений

Чтобы включить эти API в вашем проекте GCP, сделайте следующее:

  1. Перейдите на страницу API и сервисов в консоли GCP.
  2. В раскрывающемся списке « Выбор проекта» выберите проект, для которого вы хотите включить API.
  3. Щелкните Включить API и службы .
  4. В поле Поиск API и служб введите Деловые сообщения .
  5. Выберите API бизнес-сообщений .
  6. Щелкните Включить .
  7. Щелкните Включить API и службы .
  8. В поле « Поиск API и служб » введите «Бизнес-коммуникации ».
  9. Выберите API для деловых коммуникаций .
  10. Щелкните Включить .

Теперь у вашего ключа API есть разрешения на доступ к документам OpenAPI для API бизнес-сообщений и бизнес-коммуникаций.

Доступ к документам OpenAPI

Запустите эту команду, чтобы получить доступ к документу OpenAPI для API бизнес-сообщений:

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

Запустите эту команду, чтобы получить доступ к документу OpenAPI для Business Communications API:

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

Замените API_KEY своим ключом API.