واجهة برمجة التطبيقات لإدارة ميزة "مراسلة الأنشطة التجارية من Google" (RBM Management API)

تكرّر واجهة RBM Management API إمكانات وحدة تحكّم مطوّري برامج RBM. تُعدّ واجهة برمجة التطبيقات هذه مفيدة بشكل خاص للمجمّعين والشركاء الذين يديرون منصات حملاتهم الخاصة ويريدون دمج RBM بسلاسة كقناة.

‫RBM Management API هي واجهة REST API تتيح للمطوّرين تنفيذ ما يلي آليًا:

إنشاء وتعديل تعريفات وكلاء RBM وتحميل مواد العرض
إرسال وكلاء RBM لإثبات الملكية وإطلاقهم
استرداد معلومات التحقّق والإطلاق

يتم عرض واجهة RBM Management API كإضافات RCS إلى Business Communications API من Google.

بيانات اعتماد المصادقة

يمكن لأي مطوّر RBM الوصول إلى RBM Management API. عند استدعاء واجهة برمجة التطبيقات، عليك إثبات الهوية باستخدام حساب خدمة أنشأته في Developer Console.

يُستخدَم مفتاح حساب الخدمة للمصادقة مع خادم Google OAuth2 للحصول على رمز مميز للوصول يُستخدَم بعد ذلك لاستدعاء واجهة برمجة التطبيقات RBM Management API. يمكنك الاطّلاع على مزيد من المعلومات حول هذه العملية في صفحة مصادقة حساب الخدمة.

نطاق OAuth لواجهة برمجة التطبيقات هذه هو 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 بشكل أفضل، نزِّل الرمز النموذجي بمجموعة من اللغات:

تنزيل نماذج cURL
تنزيل نماذج Python
تنزيل نماذج Java
تنزيل عينات Node.js

مكتبات العملاء

تتولّى مكتبات العملاء عملية المصادقة وعملية تحويل البيانات إلى تنسيق مناسب لواجهة برمجة التطبيقات والعكس، وذلك لتسهيل عملية التطوير. يتم نشرها بلغات متعددة:

سير العمل

لإنشاء وكيل وإطلاقه باستخدام RBM Management API، اتّبِع الخطوات التالية:

إنشاء علامة تجارية
أنشئ وكيلاً في العلامة التجارية.
أضِف مختبِرين إلى الوكيل حتى تتمكّن من التحقّق من تجربة المستخدم.
إرسال الوكيل لإثبات هويته
إرسال الوكيل لإطلاقه مع مشغّل شبكة جوّال واحد أو أكثر
التحقّق من حالة الإطلاق

إدراج مشغّلي شبكات الجوّال (المناطق)

واجهة برمجة التطبيقات لإدارة ميزة "مراسلة الأنشطة التجارية من Google" (RBM Management API) تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.