OpenAPI

OpenAPI là một để mô tả API REST. 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 chúng.

Điều này cho phép bạn làm những việc sau:

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

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

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

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

    {
      "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 một tài liệu OpenAPI, hãy xem Trang web về giao dịch mua sắm.

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

Để truy cập vào các tài liệu OpenAPI, bạn phải có khoá API từ Google Cloud Dự án Nền tảng (GCP) với Business Messages và Business Communications Đã bật API.

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

• tạo một 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 tài liệu OpenAPI.

Tạo một dự án GCP

Nếu đã có một 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:

1. Chuyển đến phần Quản lý tài nguyên trong bảng điều khiển GCP.
2. Trong danh sách thả xuống Chọn tổ chức ở đầu trang, 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.
3. Nhấp vào Create Project (Tạo dự án).
4. Trong cửa sổ New Project (Dự án mới), hãy nhập tên dự án rồi chọn tài khoản thanh toán (nếu có). Tên dự án chỉ có thể chứa chữ cái, chữ số, dấu ngoặc kép, dấu gạch nối, dấu cách hoặc dấu chấm than và phải dài từ 4 đến 30 ký tự.

5. Đối với Vị trí, hãy nhập tổ chức hoặc thư mục mẹ cho dự án mới.

6. Nhấp vào Tạo.

Tạo một khoá API

1. Chuyển đến Trang thông tin đăng nhập trong bảng điều khiển của GCP.

2. Nhấp vào Tạo thông tin xác thực, rồi chọn Khoá API.

   Hộp thoại API key đã được tạo sẽ hiển thị khoá mới tạo của bạn. Hãy sao chép và bảo mật khoá của bạn. Để tìm hiểu thêm về khoá API, hãy xem Tài liệu về khoá API.

Bật Business Communications API và Business Messages API

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

1. Chuyển đến API & Dịch vụ trong bảng điều khiển của GCP.
2. Trong danh sách thả xuống Chọn dự án, hãy chọn dự án mà bạn muốn bật API.
3. Nhấp vào Bật API và dịch vụ.
4. Trong trường Tìm kiếm API và dịch vụ, hãy nhập Business Messages.
5. Chọn Business Messages API.
6. Nhấp vào Bật.
7. Nhấp vào Bật API và dịch vụ.
8. Trong trường Search for APIs and Services, hãy nhập Business Communications.
9. Chọn Business Communications API.
10. Nhấp vào Bật.

Giờ đây, khoá API của bạn có quyền truy cập vào các tài liệu OpenAPI cho Business Messages và Business Communications API.

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

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

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 Business Communications API:

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

Thay thế API_KEY bằng khoá API.