A API RBM Management replica os recursos do RBM Developer Console. Essa API é especialmente útil para agregadores e parceiros que operam as próprias plataformas de campanha e querem integrar a RBM como um canal.
A API RBM Management é uma API REST que permite aos desenvolvedores fazer o seguinte de maneira programática:
- Criar e editar definições de agentes do RBM e fazer upload de recursos.
- Enviar e lançar agentes do RBM para verificação.
- Recuperar informações de verificação e lançamento.
A API RBM Management é exposta como extensões do RCS para a API Business Communications do Google.
Credenciais de autenticação
Qualquer desenvolvedor do RBM pode acessar a API RBM Management. Ao chamar a API, você faz a autenticação usando uma conta de serviço criada no Developer Console.
A chave da conta de serviço é usada para autenticar com o servidor Google OAuth2 e receber um token de acesso, que é usado para chamar a API RBM Management. Para saber mais sobre esse processo, consulte a página Autenticação da conta de serviço.
O escopo do OAuth para essa API é businesscommunications.
Esses snippets de código demonstram como usar as bibliotecas públicas do Google para autenticação.
cURL
Ao usar o curl, é possível se autenticar gerando um token de portador de autorização com a chave da conta de serviço usando a ferramenta 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)
Recomendamos que os desenvolvedores não implementem a autenticação por conta própria devido à complexidade da implementação da expiração e da atualização de tokens.
Código de amostra
Para entender melhor como usar a API RBM Management, faça o download do código de amostra em várias linguagens:
- Baixar exemplos de cURL
- Baixar exemplos em Python
- Baixar exemplos em Java
- Baixar exemplos de Node.js
Bibliotecas de cliente
As bibliotecas de cliente processam a autenticação e a serialização e desserialização da API para simplificar o desenvolvimento. Elas são publicadas em vários idiomas:
Fluxo de trabalho
Para criar e lançar um agente com a API RBM Management, siga estas etapas:
- Crie uma marca.
- Crie um agente na marca.
- Adicione testadores ao agente para validar a experiência do usuário.
- Envie o agente para verificação.
- Envie o agente para lançamento com uma ou mais operadoras.
- Verifique o status do lançamento.