API управления RBM

API управления RBM дублирует возможности консоли разработчика RBM . Этот API особенно полезен для агрегаторов и партнеров, которые используют собственные платформы для проведения кампаний и хотят беспрепятственно интегрировать RBM в качестве канала.

API управления RBM — это REST API, который позволяет разработчикам программно выполнять следующие действия:

• Создавайте и редактируйте определения агентов RBM и загружайте ресурсы.
• Отправьте агентов RBM на проверку и запуск.
• Получите информацию для проверки и запуска.

API управления RBM предоставляется в виде расширений RCS для API бизнес-коммуникаций Google.

Учетные данные для аутентификации

Любой разработчик RBM может получить доступ к API управления RBM. При вызове API вы проходите аутентификацию с помощью учетной записи службы, созданной вами в консоли разработчика .

Ключ вашей учетной записи службы используется для аутентификации на сервере Google OAuth2 с целью получения токена доступа, который затем используется для вызова API управления RBM. Подробнее об этом процессе можно прочитать на странице «Аутентификация учетной записи службы» .

Область действия 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)

Этот код представляет собой фрагмент из нашего примера API управления RBM .

Мы настоятельно рекомендуем разработчикам не реализовывать аутентификацию самостоятельно, учитывая сложность реализации истечения срока действия и обновления токенов.

Пример кода

Для лучшего понимания того, как использовать API управления RBM, загрузите примеры кода на разных языках:

• Скачать примеры cURL
• Скачать примеры кода на Python
• Скачать примеры кода на Java
• Скачать примеры Node.js

Клиентские библиотеки

Клиентские библиотеки обеспечивают аутентификацию, а также сериализацию и десериализацию API, упрощая разработку. Они доступны на нескольких языках:

• C#
• Java
• Node.js

Рабочий процесс

Для создания и запуска агента с использованием API управления RBM выполните следующие действия:

1. Создайте бренд.
2. Создайте агента в рамках бренда.
3. Добавьте тестировщиков в команду агента, чтобы проверить удобство использования.
4. Отправьте данные агента на проверку.
5. Отправьте заявку агенту на запуск проекта с одним или несколькими перевозчиками.
6. Проверьте статус запуска.