RBM Management API

‫RBM Management API משכפל את היכולות של RBM Developer Console. ממשק ה-API הזה שימושי במיוחד לאגרגטורים ולשותפים שמפעילים פלטפורמות קמפיינים משלהם ורוצים לשלב את RBM כערוץ בצורה חלקה.

RBM Management API הוא API ל-REST שמאפשר למפתחים לבצע את הפעולות הבאות באופן פרוגרמטי:

  • ליצור ולערוך הגדרות של סוכני RBM ולהעלות נכסים.
  • שליחת נציגי RBM לאימות ולהשקה.
  • אחזור פרטי האימות וההפעלה.

‫RBM Management API נחשף כתוספי RCS ל-Business Communications API של Google.

פרטי אימות

כל מפתח RBM יכול לגשת ל-RBM Management API. כשמפעילים את ה-API, צריך לבצע אימות באמצעות חשבון שירות שיצרתם ב-Developer Console.

המפתח של חשבון השירות משמש לאימות בשרת Google OAuth2 כדי לקבל אסימון גישה, שמשמש לאחר מכן לקריאה ל-RBM Management API. מידע נוסף על התהליך הזה זמין בדף אימות של חשבון שירות.

היקף ההרשאות של OAuth עבור ה-API הזה הוא businesscommunications.

קטעי הקוד האלה מדגימים איך להשתמש בספריות הציבוריות של Google לאימות.

cURL

כשמשתמשים ב-curl, אפשר לבצע אימות על ידי יצירת אסימון למוכ"ז להרשאה מהמפתח של חשבון השירות באמצעות הכלי 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)
 הקוד הזה הוא קטע מתוך דוגמה ל-RBM Management API.

מומלץ מאוד שמפתחים לא יטמיעו אימות בעצמם, כי הטמעה של תוקף טוקן ורענון שלו היא מורכבת.

קוד לדוגמה

כדי להבין טוב יותר איך להשתמש ב-RBM Management API, אפשר להוריד את דוגמת הקוד במגוון שפות:

ספריות לקוח

ספריות הלקוח מטפלות באימות ובארגון ובביטול הארגון של ה-API כדי לפשט את הפיתוח. הם מתפרסמים בכמה שפות:

תהליך עבודה

כדי ליצור ולהפעיל נציג באמצעות RBM Management API, פועלים לפי השלבים הבאים:

  1. יוצרים מותג.
  2. יוצרים סוכן במותג.
  3. מוסיפים בודקים לסוכן כדי לאמת את חוויית המשתמש.
  4. שולחים את הנציג לאימות.
  5. שולחים את הנציג להפעלה עם ספק אחד או יותר.
  6. בודקים את סטטוס ההפעלה.
הבא
הצגת רשימה של ספקים (אזורים)