Guia de integração

Receber chave privada

Como usar a interface de integração

Para fazer a integração com a API, você precisa criar um projeto do Google Cloud. Depois, crie uma conta de serviço e receba uma chave privada. Para começar, clique neste botão:

Criar conta de serviço

Gerando manualmente a chave

Se a interface acima falhar, tente o seguinte:

  1. Acesse o Console do Google Cloud.
  2. Escolha o projeto usando a API que será acessada.
  3. No menu administrador do IAM à esquerda, encontre contas de serviço e crie uma nova conta de serviço que será a proprietária do projeto.
  4. Após a criação da conta de serviço, você receberá uma chave privada.

Autorizar conta de serviço

Depois de criar uma conta de serviço:

  1. Entre em contato com a equipe do GTAF em mdp-support@google.com com uma Conta do Google que seja a proprietária do projeto. Colocaremos a Conta do Google na lista de permissões para acessar os endpoints da API Mobile Data Plan Sharing.
  2. Associe a conta de serviço à operadora no Portal do ISP do Google. A operadora pode fazer essa associação no Acesso à API.

Ativar biblioteca

Depois que a lista de permissões for concluída:

  1. Visite o Google Cloud Console.
  2. Verifique se você selecionou o projeto correto no menu suspenso na barra de menus superior.
  3. Ative a API Mobile Data Plan Sharing na biblioteca de APIs.
  4. Ative a API de pré-compartilhamento do plano de dados para dispositivos móveis do Preprod na biblioteca de APIs.

Testar acesso à API

Para testar seu acesso aos métodos secundários do Google, faça o seguinte:

  1. Instale oauth2l.

  2. Consiga um token de acesso para sua conta de serviço, conforme mostrado a seguir. O your-service-account-key-file.json é um arquivo importante da sua conta de serviço.

    > oauth2l fetch --json your-service-account-key-file.json dataplansharing

    Observe que o token de acesso expira em cerca de uma hora. Antes de executar o comando acima outra vez para um novo token de acesso, execute oauth2l reset para limpar o cache local.

  3. Emita chamadas de teste da seguinte maneira: YOUR-ASN precisa ser um dos ASNs que você envia quando configuramos o GTAF durante o processo de integração. ACCESS-TOKEN-OBTAINED é a saída do comando oauth2l fetch acima. PLAN_STATUS é o corpo da solicitação PlanStatus que você quer enviar ao GTAF.

    > url_domain="mobiledataplansharing.googleapis.com"
> url_path="v1/operators/YOUR-ASN/clients/mobiledataplan/users/USER_KEY/planStatus"
> curl -H "Content-Type: application/json" \
       -d 'PLAN_STATUS' \
       -X POST "https://$url_domain/$url_path?access_token=ACCESS-TOKEN-OBTAINED"

Chamadas de API programáticas

Siga as instruções para fazer chamadas autorizadas para métodos laterais do Google com o seguinte escopo OAuth:

https://www.googleapis.com/auth/dataplansharing

Compartilhar a propriedade do projeto

Embora a configuração inicial envolva uma única Conta do Google, é recomendável que um grupo de usuários autorizados tenha propriedade do projeto. No Console do Google Cloud, no menu Administrador do IAM, você pode adicionar novos membros (incluindo a conta dos grupos do Google) para serem proprietários do projeto.