Este guia explica como usar o OAuth 2.0 para solicitar acesso às contas de comerciante de outras partes. Se você for um provedor terceirizado, use este fluxo de trabalho para permitir que seu app solicite acesso às contas de comerciante dos seus clientes.
Se você estiver desenvolvendo um app interno que precisa acessar apenas sua conta de comerciante, consulte acessar sua conta.
Solicitar verificação de apps
Os apps que acessam a API Merchant precisam passar pelo processo de análise de verificação OAuth. Os apps não verificados vão receber avisos e terão funcionalidade limitada.
Um app é qualquer coisa com um ID de cliente OAuth 2.0 exclusivo no Google Cloud.
O processo de verificação normalmente leva de três a cinco dias úteis. Para saber mais e enviar uma solicitação de verificação, consulte verificação de apps.
Esta política se aplica a todos os apps. Recomendamos que todos os apps passem pelo processo de verificação o mais cedo possível para evitar interrupções nos negócios.
Receber escopos do OAuth
Configure a autorização incremental para evitar problemas com a seleção de escopo.
Todos os escopos do OAuth são desmarcados por padrão na tela de consentimento do app se você solicitar mais de um. Quando o app mostra a tela de consentimento a um usuário, ele precisa selecionar manualmente cada escopo para autorizar o acesso.
Para usar a API Merchant, seu app precisa solicitar o seguinte escopo na tela de consentimento do OAuth:
https://www.googleapis.com/auth/content
Verifique a resposta de uma solicitação OAuth para confirmar que o app recebeu esse escopo.
Consulte as políticas do OAuth 2.0 para mais detalhes.
Autorizar solicitações
Todas as solicitações enviadas pelo seu aplicativo à API Merchant precisam incluir um token de autorização. O token também identifica o aplicativo para o Google.
Sobre os protocolos de autorização
O aplicativo deve obrigatoriamente usar o OAuth 2.0 para autorizar solicitações. Não há outros protocolos de autorização compatíveis. Se o aplicativo usa o Fazer login com o Google, alguns aspectos da autorização são administrados para você.
Autorizar solicitações com OAuth 2.0
Todas as solicitações para a API Merchant precisam ser autorizadas por um usuário autenticado.
Os detalhes do processo de autorização ou “fluxo” para o OAuth 2.0 variam um pouco, dependendo do tipo de aplicativo que você está criando. O processo geral a seguir se aplica a todos os tipos de aplicativo:
- Ao criar seu aplicativo, registre-o usando o Console de APIs do Google. Em seguida, o Google fornece informações que serão usadas mais tarde, como um ID e uma chave secreta do cliente.
- Ative a API Merchant no Console de APIs do Google. Se ela não estiver no Console de APIs, pule essa etapa.
- Quando seu aplicativo precisar de acesso aos dados do usuário, ele solicitará ao Google um determinado escopo do acesso.
- O Google exibe uma tela de consentimento ao usuário, pedindo para que o aplicativo seja autorizado a solicitar alguns dos dados dele.
- Se o usuário aprovar, o Google fornecerá ao aplicativo um token de acesso de curta duração.
- O aplicativo solicita dados de usuário, anexando o token de acesso à solicitação.
- Se o Google determinar que a solicitação e o token são válidos, ele retornará os dados solicitados.
Alguns fluxos incluem etapas adicionais, como atualizar tokens para adquirir novos tokens de acesso. Para mais informações sobre fluxos de vários tipos de aplicativos, acesse a documentação OAuth 2.0 do Google.
Confira as informações de escopo do OAuth 2.0 para a API Merchant:
Escopo | Significado |
---|---|
https://www.googleapis.com/auth/content |
Acesso de leitura e gravação. |
Para solicitar acesso usando o OAuth 2.0, seu aplicativo precisa de informações do escopo, bem como informações fornecidas pelo Google durante o registro do aplicativo, como o ID e a chave secreta do cliente.
Confira um exemplo que pode ser usado para autorização.