رابط برنامهنویسی کاربردی مدیریت RBM قابلیتهای کنسول توسعهدهندگان RBM را تکرار میکند. این رابط برنامهنویسی کاربردی (API) بهویژه برای گردآورندگان و شرکایی که پلتفرمهای کمپین خود را اداره میکنند و میخواهند RBM را به عنوان یک کانال به طور یکپارچه ادغام کنند، مفید است.
API مدیریت RBM یک API REST است که به توسعهدهندگان اجازه میدهد تا به صورت برنامهنویسی موارد زیر را انجام دهند:
- تعاریف عامل RBM را ایجاد و ویرایش کنید و داراییها را بارگذاری کنید.
- عوامل RBM را برای تأیید و راهاندازی ارسال کنید.
- اطلاعات تأیید و راهاندازی را بازیابی کنید.
رابط برنامهنویسی کاربردی مدیریت RBM به عنوان افزونههای RCS در رابط برنامهنویسی کاربردی ارتباطات تجاری گوگل (Google's Business Communications API) قرار دارد.
اعتبارنامههای احراز هویت
هر توسعهدهنده RBM میتواند به API مدیریت RBM دسترسی داشته باشد. هنگام فراخوانی API، شما با استفاده از یک حساب کاربری سرویس که در کنسول توسعهدهندگان ایجاد کردهاید، احراز هویت میشوید.
کلید حساب سرویس شما برای احراز هویت با سرور Google OAuth2 و دریافت یک توکن دسترسی استفاده میشود که سپس برای فراخوانی API مدیریت RBM استفاده میشود. میتوانید اطلاعات بیشتر در مورد این فرآیند را در صفحه احراز هویت حساب سرویس مطالعه کنید.
دامنه احراز هویت این API، businesscommunications است.
این قطعه کدها نحوه استفاده از کتابخانههای عمومی گوگل برای احراز هویت را نشان میدهند.
حلقه
هنگام استفاده از curl، میتوانید با تولید یک توکن حامل مجوز از کلید حساب سرویس خود با استفاده از ابزار oauth2l، احراز هویت کنید.-H "`oauth2l header --json rbm-developer-service-account-credentials.json businesscommunications`"پایتون
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)
با توجه به پیچیدگی پیادهسازی انقضا و بهروزرسانی توکن، اکیداً به توسعهدهندگان توصیه میکنیم که خودشان احراز هویت را پیادهسازی نکنند.
کد نمونه
برای درک بهتر نحوه استفاده از API مدیریت RBM، کد نمونه را به زبانهای مختلف دانلود کنید:
- دانلود نمونههای cURL
- دانلود نمونههای پایتون
- دانلود نمونههای جاوا
- دانلود نمونههای Node.js
کتابخانههای کلاینت
کتابخانههای کلاینت، احراز هویت و مرتبسازی و از رده خارج کردن API را برای سادهسازی توسعه شما انجام میدهند. آنها به چندین زبان منتشر شدهاند:
گردش کار
برای ایجاد و راهاندازی یک عامل با API مدیریت RBM، این مراحل را دنبال کنید:
- یک برند ایجاد کنید.
- یک عامل در برند ایجاد کنید.
- آزمایشکنندگان را به عامل اضافه کنید تا بتوانید تجربه کاربری را اعتبارسنجی کنید.
- برای تأیید به نماینده ارسال کنید.
- نماینده را برای راهاندازی با یک یا چند شرکت مخابراتی ارسال کنید.
- وضعیت پرتاب را بررسی کنید.