L'API RBM Management

L'API RBM Management reproduit les fonctionnalités de la console développeur RBM. Cette API est particulièrement utile pour les agrégateurs et les partenaires qui gèrent leurs propres plates-formes de campagne et souhaitent intégrer RBM de manière fluide en tant que canal.

L'API RBM Management est une API REST qui permet aux développeurs d'effectuer les opérations suivantes de manière programmatique :

  • Créer et modifier des définitions d'agents RBM et importer des composants
  • Envoyez vos agents RBM pour validation et lancement.
  • Récupérer les informations de validation et de lancement.

L'API RBM Management est exposée en tant qu'extensions RCS de l'API Business Communications de Google.

Identifiants d'authentification

Tous les développeurs RBM peuvent accéder à l'API RBM Management. Lorsque vous appelez l'API, vous vous authentifiez à l'aide d'un compte de service que vous avez créé dans la console Developers.

Votre clé de compte de service est utilisée pour l'authentification auprès du serveur Google OAuth2 afin d'obtenir un jeton d'accès, qui est ensuite utilisé pour appeler l'API RBM Management. Pour en savoir plus sur ce processus, consultez la page Authentification des comptes de service.

Le champ d'application OAuth pour cette API est businesscommunications.

Ces extraits de code montrent comment utiliser les bibliothèques publiques de Google pour l'authentification.

cURL

Lorsque vous utilisez curl, vous pouvez vous authentifier en générant un jeton de support d'autorisation à partir de la clé de votre compte de service à l'aide de l'outil 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)
 Ce code est un extrait de notre exemple d'API RBM Management.

Nous conseillons vivement aux développeurs de ne pas implémenter eux-mêmes l'authentification, compte tenu de la complexité de l'implémentation de l'expiration et de l'actualisation des jetons.

Exemple de code

Pour mieux comprendre comment utiliser l'API RBM Management, téléchargez l'exemple de code dans différentes langues :

Bibliothèques clientes

Les bibliothèques clientes gèrent l'authentification, ainsi que le marshalling et l'unmarshalling de l'API pour simplifier votre développement. Elles sont publiées dans plusieurs langues :

Workflow

Pour créer et lancer un agent avec l'API RBM Management, procédez comme suit :

  1. Créez une marque.
  2. Créez un agent dans la marque.
  3. Ajoutez des testeurs à l'agent pour valider l'expérience utilisateur.
  4. Envoyez l'agent pour validation.
  5. Envoyez l'agent pour le lancement avec un ou plusieurs opérateurs.
  6. Vérifiez l'état du lancement.
Suivant
Lister les opérateurs (régions)