Trang này được dịch bởi Cloud Translation API.

API mở

OpenAPI là một bản đặc tả để mô tả các API REST. Bằng cách sử dụng quy cách OpenAPI 2.0, bạn có thể tạo tài liệu OpenAPI cho Business Messages và Business Communications API để mô tả cấu trúc của những tài liệu này.

Nhờ vậy, bạn có thể:

Tạo thư viện ứng dụng bằng ngôn ngữ bạn muốn
Tạo mã giả lập máy chủ
Sử dụng các công cụ quản lý API

Cấu trúc cơ bản của tài liệu OpenAPI

Tài liệu OpenAPI mô tả nền tảng của API REST. Tài liệu này xác định tên và nội dung mô tả về API, các điểm cuối (đường dẫn) riêng lẻ trong API, cách phương thức gọi được xác thực và nhiều thông tin khác.

Hãy nhấp vào bên dưới để xem ví dụ về cấu trúc cơ bản này.

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

Để tìm hiểu thêm về cấu trúc của tài liệu OpenAPI, hãy xem trang web của swagger.

Cách truy cập vào tài liệu OpenAPI

Để truy cập vào các tài liệu OpenAPI, bạn phải có một khoá API từ dự án Google Cloud Platform (GCP) và đã bật các API cho Business Messages và Business Communications.

Hãy làm theo các phần bên dưới để

tạo dự án GCP
tạo một khóa API
bật Business Messages API và Business Communications API

Sau khi hoàn tất các bước này, bạn có thể truy cập vào các tài liệu OpenAPI.

Tạo dự án GCP

Nếu đã có dự án GCP, bạn có thể sử dụng dự án đó để tạo khoá API.

Để tạo một dự án GCP mới, hãy làm như sau:

Di chuyển đến trang Quản lý tài nguyên trong bảng điều khiển GCP.
Trong danh sách thả xuống Chọn tổ chức ở đầu trang, hãy chọn tổ chức mà bạn muốn tạo dự án. Nếu bạn là người dùng thử miễn phí, hãy bỏ qua bước này.
Nhấp vào Create Project (Tạo dự án).
Trong cửa sổ New Project (Dự án mới), hãy nhập tên dự án rồi chọn một tài khoản thanh toán (nếu có). Tên dự án chỉ có thể chứa chữ cái, số, dấu nháy đơn, dấu gạch nối, dấu cách hoặc dấu chấm than, đồng thời phải có từ 4 đến 30 ký tự.
Đối với Location (Vị trí), hãy nhập tổ chức mẹ hoặc thư mục gốc của dự án mới.
Nhấp vào Tạo.

Tạo một khoá API

Di chuyển đến trang Thông tin xác thực trong bảng điều khiển của GCP.
Nhấp vào Tạo thông tin xác thực, sau đó chọn Khoá API.

Hộp thoại Đã tạo khoá API hiển thị khoá mới tạo. Sao chép và giữ an toàn khoá của bạn. Để tìm hiểu thêm về các khoá API, hãy xem Tài liệu về khoá API.

Bật API Business Communications và Business Messages API

Để bật các API này trong dự án GCP, hãy làm như sau:

Chuyển đến trang API và dịch vụ trong bảng điều khiển của GCP.
Trong danh sách thả xuống Select project (Chọn dự án), hãy chọn dự án mà bạn muốn bật API.
Nhấp vào Bật API và dịch vụ.
Trong trường Tìm kiếm API và dịch vụ, hãy nhập Tin nhắn cho doanh nghiệp.
Chọn Business Messages API.
Nhấp vào Bật.
Nhấp vào Bật API và dịch vụ.
Trong trường Search and APIs (Tìm kiếm API và Dịch vụ), hãy nhập Business Communications.
Chọn Business Communications API.
Nhấp vào Bật.

Khoá API của bạn hiện có quyền truy cập vào tài liệu OpenAPI cho API Business Messages và Business Communications.

Truy cập vào tài liệu OpenAPI

Chạy lệnh này để truy cập vào tài liệu OpenAPI cho API Business Messages:

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

Chạy lệnh này để truy cập vào tài liệu OpenAPI cho API Business Communications:

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

Thay thế API_KEY bằng khoá API.