API Quản lý RBM

RBM Management API sao chép các chức năng của RBM Developer Console. API này đặc biệt hữu ích cho những đơn vị tập hợp và đối tác vận hành nền tảng chiến dịch riêng và muốn tích hợp RBM một cách liền mạch dưới dạng một kênh.

RBM Management API là một REST API cho phép nhà phát triển thực hiện các thao tác sau theo phương thức lập trình:

  • Tạo và chỉnh sửa định nghĩa về tác nhân RBM, đồng thời tải các thành phần lên.
  • Gửi nhân viên hỗ trợ RBM để xác minh và ra mắt.
  • Truy xuất thông tin xác minh và thông tin ra mắt.

RBM Management API được cung cấp dưới dạng các tiện ích RCS cho Business Communications API của Google.

Thông tin xác thực

Mọi nhà phát triển RBM đều có thể truy cập vào RBM Management API. Khi gọi API, bạn sẽ xác thực bằng Tài khoản dịch vụ mà bạn đã tạo trong Developer Console.

Khoá Tài khoản dịch vụ của bạn được dùng để xác thực với máy chủ Google OAuth2 nhằm lấy mã truy cập. Sau đó, mã truy cập này được dùng để gọi RBM Management API. Bạn có thể đọc thêm về quy trình này trên trang Xác thực tài khoản dịch vụ.

Phạm vi oauth cho API này là businesscommunications.

Các đoạn mã này minh hoạ cách sử dụng các thư viện công khai của Google để xác thực.

cURL

Khi sử dụng curl, bạn có thể xác thực bằng cách tạo mã thông báo uỷ quyền của người mang từ khoá Tài khoản dịch vụ bằng công cụ oauth2l.
-H "`oauth2l header --json rbm-developer-service-account-credentials.json businesscommunications`"

Python

from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account

BASE_ENDPOINT = 'https://businesscommunications.googleapis.com/v1/'

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']

credentials = service_account.Credentials.from_service_account_file(
  './rbm-developer-service-account-credentials.json',
  scopes = SCOPES)

authed_session = AuthorizedSession(credentials)
Đây là một đoạn mã trong mẫu RBM Management API của chúng tôi.

Nhà phát triển không nên tự triển khai quy trình xác thực do sự phức tạp của việc triển khai tính năng hết hạn và làm mới mã thông báo.

Mã mẫu

Để hiểu rõ hơn về cách sử dụng API Quản lý RBM, hãy tải mã mẫu xuống bằng nhiều ngôn ngữ:

Thư viện ứng dụng

Thư viện ứng dụng xử lý việc xác thực, sắp xếp và huỷ sắp xếp API để đơn giản hoá quá trình phát triển của bạn. Các hướng dẫn này được xuất bản bằng nhiều ngôn ngữ:

Luồng công việc

Để tạo và chạy một nhân viên hỗ trợ bằng RBM Management API, hãy làm theo các bước sau:

  1. Tạo thương hiệu.
  2. Tạo một tác nhân trong thương hiệu.
  3. Thêm người kiểm thử vào tác nhân để bạn có thể xác thực trải nghiệm người dùng.
  4. Gửi nhân viên hỗ trợ để xác minh.
  5. Gửi nhân viên hỗ trợ để ra mắt với một hoặc nhiều hãng vận chuyển.
  6. Kiểm tra trạng thái phát hành.