RBM Management API

RBM Management API mereplikasi kemampuan Konsol Developer RBM. API ini sangat berguna bagi agregator dan partner yang mengoperasikan platform kampanye mereka sendiri dan ingin mengintegrasikan RBM sebagai saluran dengan lancar.

RBM Management API adalah REST API yang memungkinkan developer melakukan hal berikut secara terprogram:

  • Buat dan edit definisi agen RBM serta upload aset.
  • Kirimkan agen RBM untuk verifikasi dan peluncuran.
  • Ambil informasi verifikasi dan peluncuran.

RBM Management API ditampilkan sebagai ekstensi RCS ke Business Communications API Google.

Kredensial autentikasi

Setiap developer RBM dapat mengakses RBM Management API. Saat memanggil API, Anda melakukan autentikasi menggunakan Akun Layanan yang telah Anda buat di Developer Console.

Kunci Akun Layanan Anda digunakan untuk mengautentikasi dengan server Google OAuth2 untuk mendapatkan token akses yang kemudian digunakan untuk memanggil RBM Management API. Anda dapat membaca lebih lanjut proses ini di halaman Autentikasi Akun Layanan.

Cakupan oauth untuk API ini adalah businesscommunications.

Cuplikan kode ini menunjukkan cara menggunakan library publik Google untuk autentikasi.

cURL

Saat menggunakan curl, Anda dapat melakukan autentikasi dengan membuat token pemilik otorisasi dari kunci Akun Layanan menggunakan alat 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)
Kode ini adalah kutipan dari contoh RBM Management API kami.

Sebaiknya developer tidak menerapkan autentikasi sendiri mengingat kompleksitas penerapan masa berlaku dan perpanjangan token.

Kode contoh

Untuk lebih memahami cara menggunakan RBM Management API, download kode contoh dalam berbagai bahasa:

Library klien

Library klien menangani autentikasi serta marshalling dan unmarshalling API untuk menyederhanakan pengembangan Anda. Artikel ini dipublikasikan dalam beberapa bahasa:

Alur kerja

Untuk membuat dan meluncurkan agen dengan RBM Management API, ikuti langkah-langkah berikut:

  1. Buat merek.
  2. Buat agen dalam merek.
  3. Tambahkan penguji ke agen agar Anda dapat memvalidasi pengalaman pengguna.
  4. Kirimkan agen untuk verifikasi.
  5. Kirimkan agen untuk diluncurkan dengan satu atau beberapa operator.
  6. Periksa status peluncuran.