आरबीएम मैनेजमेंट एपीआई

RBM Management API, RBM Developer Console की सुविधाओं को दोहराता है. यह एपीआई, खास तौर पर उन एग्रीगेटर और पार्टनर के लिए मददगार है जो अपने कैंपेन प्लैटफ़ॉर्म चलाते हैं और RBM को एक चैनल के तौर पर आसानी से इंटिग्रेट करना चाहते हैं.

RBM Management API एक REST API है. इसकी मदद से डेवलपर, प्रोग्राम के हिसाब से ये काम कर सकते हैं:

  • RBM एजेंट की परिभाषाएं बनाना और उनमें बदलाव करना. साथ ही, ऐसेट अपलोड करना.
  • पुष्टि करने और लॉन्च करने के लिए, RBM एजेंट सबमिट करें.
  • पुष्टि और लॉन्च करने से जुड़ी जानकारी वापस पाएं.

RBM Management API को Google के Business Communications API के RCS एक्सटेंशन के तौर पर दिखाया जाता है.

पुष्टि करने के लिए क्रेडेंशियल

कोई भी 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 का इस्तेमाल करने का तरीका बेहतर ढंग से समझने के लिए, अलग-अलग भाषाओं में सैंपल कोड डाउनलोड करें:

क्लाइंट लाइब्रेरी

क्लाइंट लाइब्रेरी, पुष्टि करने के साथ-साथ एपीआई मार्शेलिंग और अनमार्शेलिंग को मैनेज करती हैं, ताकि आपके लिए डेवलपमेंट को आसान बनाया जा सके. ये कई भाषाओं में पब्लिश किए जाते हैं:

वर्कफ़्लो

RBM Management API की मदद से एजेंट बनाने और उसे लॉन्च करने के लिए, यह तरीका अपनाएं:

  1. कोई ब्रैंड बनाएं.
  2. ब्रैंड में कोई एजेंट बनाएं.
  3. एजेंट में टेस्टर जोड़ें, ताकि उपयोगकर्ता अनुभव की पुष्टि की जा सके.
  4. पुष्टि के लिए एजेंट की जानकारी सबमिट करें.
  5. मोबाइल और इंटरनेट सेवा देने वाली एक या उससे ज़्यादा कंपनियों के साथ लॉन्च करने के लिए, एजेंट को सबमिट करें.
  6. लॉन्च की स्थिति देखें.