OpenAPI

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

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

• Создавайте клиентские библиотеки на предпочитаемом вами языке.
• Создание заглушек сервера
• Используйте инструменты управления 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-интерфейсами бизнес-сообщений и бизнес-коммуникаций.

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

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

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

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

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

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

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

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

6. Нажмите Создать .

Создайте ключ API

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

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

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

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

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

1. Перейдите на страницу API и сервисы в консоли GCP.
2. В раскрывающемся списке «Выбрать проект» выберите проект, для которого вы хотите включить API.
3. Нажмите «Включить API и службы» .
4. В поле «Поиск API и сервисов» введите Business Messages .
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 для API бизнес-коммуникаций:

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

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