OpenAPI

OpenAPI 是說明 REST API 的規格使用 OpenAPI 規範 2.0，您可以為 Business Messages 和 Business 建立 OpenAPI 文件用於說明其結構的通訊 API

如此一來，您就能：

使用您偏好的語言建立用戶端程式庫
建立伺服器虛設常式
使用 API 管理工具

OpenAPI 文件的基本結構

OpenAPI 文件說明 REST API 的介面。本文件定義 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 文件

您必須具備 Google Cloud 的 API 金鑰，才能存取 OpenAPI 文件具有 Business Messages 和 Business Communications 的平台 (GCP) 專案 API 已啟用。

請按照下方各節操作，

建立 GCP 專案
建立 API 金鑰
啟用 Business Messages API 和 Business Communications API

完成這些步驟後，您就可以存取 OpenAPI 文件。

建立 GCP 專案

如果您已經有 GCP 專案，可以用該專案建立 API 金鑰。

如要建立新的 GCP 專案，請按照下列步驟操作：

前往「管理資源」頁面。管理頁面
在頁面頂端的「選取機構」下拉式清單中，選取要建立專案的機構。如果您是免費試用的使用者，請略過這個步驟。
按一下 [建立專案]。
在「New Project」視窗中輸入專案名稱，然後選取帳單帳戶。專案名稱只能由英文字母、數字和單個英文字母組成引號、連字號、空格或驚嘆號，長度必須介於 4 至 30 個字元之間。
在「位置」部分，輸入新專案的上層機構或資料夾。
按一下「建立」。

建立 API 金鑰

前往「憑證」頁面 GCP 控制台開始
按一下 [建立憑證]，然後選取 [API 金鑰]。

「API key created」(建立的 API 金鑰) 對話方塊會顯示您新建立的金鑰。請複製您的金鑰並妥善保管。如要進一步瞭解 API 金鑰，請參閱 API 金鑰說明文件。

啟用 Business Communications API 和 Business Messages API

如要在 GCP 專案中啟用這些 API，請按照下列步驟操作：

前往 API 和 GCP 控制台中的「服務」頁面。
在「選取專案」下拉式清單中，選取以及您要啟用 API 的 API 專案
點選「啟用 API 和服務」。
在「搜尋 API 和服務」欄位中輸入 Business Messages。
選取「Business Messages API」。
按一下「啟用」。
點選「啟用 API 和服務」。
在「搜尋 API 和服務」欄位中輸入 Business Communications。
選取「Business Communications API」。
按一下「啟用」。

現在您的 API 金鑰有權存取以下項目的 OpenAPI 文件： Business Messages 和 Business Communications API。

存取 OpenAPI 文件

執行下列指令，存取 Business Messages API 的 OpenAPI 文件：

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

執行下列指令，存取 Business Communications API 的 OpenAPI 文件：

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

然後將 API_KEY 替換成您的 API 金鑰。

OpenAPI 透過集合功能整理內容 你可以依據偏好儲存及分類內容。