Interfejs API zarządzania RBM

Interfejs RBM Management API odzwierciedla możliwości konsoli programisty RBM. Ten interfejs API jest szczególnie przydatny dla agregatorów i partnerów, którzy obsługują własne platformy kampanii i chcą bezproblemowo zintegrować RBM jako kanał.

Interfejs RBM Management API to interfejs API REST, który umożliwia programistom wykonywanie tych czynności:

  • Tworzenie i edytowanie definicji agentów RBM oraz przesyłanie komponentów.
  • Przesyłanie agentów RBM do weryfikacji i wdrożenia.
  • Pobierz informacje o weryfikacji i uruchomieniu.

Interfejs RBM Management API jest udostępniany jako rozszerzenia RCS interfejsu Business Communications API Google.

Dane logowania

Każdy deweloper RBM może uzyskać dostęp do interfejsu RBM Management API. Podczas wywoływania interfejsu API uwierzytelnianie odbywa się za pomocą konta usługi utworzonego w Konsoli Play.

Klucz konta usługi służy do uwierzytelniania na serwerze Google OAuth2 w celu uzyskania tokena dostępu, który jest następnie używany do wywoływania interfejsu RBM Management API. Więcej informacji o tym procesie znajdziesz na stronie Uwierzytelnianie konta usługi.

Zakres protokołu OAuth dla tego interfejsu API to businesscommunications.

Te fragmenty kodu pokazują, jak używać publicznych bibliotek Google do uwierzytelniania.

cURL

Jeśli używasz narzędzia curl, możesz uwierzytelnić się, generując token autoryzacyjny z klucza konta usługi za pomocą narzędzia 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)
 Ten kod to fragment naszego przykładowego kodu interfejsu RBM Management API.

Zdecydowanie odradzamy deweloperom samodzielne wdrażanie uwierzytelniania ze względu na złożoność implementacji wygasania i odświeżania tokenów.

Przykładowy kod

Aby lepiej zrozumieć, jak korzystać z interfejsu RBM Management API, pobierz przykładowy kod w różnych językach:

Biblioteki klienta

Biblioteki klienta obsługują uwierzytelnianie oraz przekształcanie i odwrotne przekształcanie interfejsu API, co upraszcza proces tworzenia. Są one publikowane w wielu językach:

Przepływ pracy

Aby utworzyć i uruchomić agenta za pomocą interfejsu RBM Management API, wykonaj te czynności:

  1. Utwórz markę.
  2. Utwórz agenta w marce.
  3. Dodaj testerów do agenta, aby sprawdzić wygodę użytkowników.
  4. Prześlij agenta do weryfikacji.
  5. Prześlij agenta do uruchomienia u co najmniej jednego operatora.
  6. Sprawdź stan uruchomienia.
Dalej
Wyświetlenie listy operatorów (regionów)