Para usar a API Merchant com eficiência, é importante entender os conceitos de registro, autenticação e autorização. Eles têm propósitos distintos para garantir o acesso seguro e correto aos dados do Merchant Center.
Terminologia
Registro, autenticação e autorização estão relacionados, mas cada um tem um significado e propósito distintos.
- Autenticação: nesse processo, o serviço verifica a identidade do usuário ou aplicativo que faz uma solicitação de API. A API Merchant usa mecanismos padrão do Google , como o OAuth 2.0. Para mais informações, consulte Autenticar solicitações e Autenticar como sua própria conta.
- Autorização: esse processo determina quais ações o usuário ou aplicativo autenticado pode realizar usando uma conta do Merchant Center. Ele responde à pergunta "O que você pode fazer?" com base nos papéis e permissões concedidos ao usuário autenticado na conta do Merchant Center. Por exemplo, um usuário pode estar autorizado a ler dados de produtos, mas não a modificar as configurações da conta.
- Registro: em relação à API Merchant, esse é um processo de configuração única que permite que o Google envie avisos de serviço importantes para as contas de comerciante que você gerencia. O registro adiciona seus endereços de e-mail de desenvolvedor à sua conta principal do Merchant Center e a vincula aos IDs do projeto do Google Cloud que você usa para autenticação. Essa vinculação permite que seu aplicativo receba avisos de serviço para todas as contas de comerciante que você gerencia. Para mais informações, consulte Criar um projeto do Google Cloud Project.
Registro
O processo de registro é essencial para permitir que seu aplicativo use a API Merchant. O que você precisa saber:
Pré-requisitos
Para se registrar e usar a API Merchant, você precisa do seguinte:
- Conta do Merchant Center: é necessário ter uma conta do Merchant Center.
- Acesso de administrador:a Conta do Google que você usa para iniciar a chamada de registro precisa ter privilégios de administrador na conta do Merchant Center que você está registrando.
- Projeto do Google Cloud: seu aplicativo precisa estar associado a um projeto do Google Cloud. Esse projeto fornece as credenciais necessárias (como IDs do cliente OAuth 2.0) para que seu aplicativo seja autenticado.
Por que não é possível registrar um projeto na nuvem compartilhado do Google Cloud
Ferramentas como o OAuth Playground do Google e o APIs Explorer usam projetos compartilhados do Google Cloud. Não é possível se registrar com projetos compartilhados porque:
- Eles são destinados a testes e exploração, não para a identidade do aplicativo de produção.
- O registro deles implicaria um link entre a ferramenta compartilhada e seus dados específicos do Merchant Center e pode resultar em comunicação indesejada.
Seu aplicativo precisa do próprio projeto dedicado do Google Cloud para que as comunicações da API Merchant enviadas pelo Google sejam relevantes para seu uso real.
No entanto, você pode usar os webapps do OAuth Playground e do APIs Explorer para usar a API Merchant em casos de uso de experimentação e não produção.
Encontrar o ID do projeto do Google Cloud
É possível encontrar o ID do projeto e o número do projeto no console do Google Cloud. Para mais detalhes, consulte Encontrar o nome, o número e o ID do projeto.
Fazer a chamada de registro
Registre-se usando o
registerGcp
método na sub-API Accounts. Essa chamada associa o número do projeto do Google Cloud à conta do Merchant Center.
Durante o processo, forneça um endereço de e-mail associado a um usuário individual que você usa para chamar a API. Esse e-mail precisa pertencer a um usuário com acesso de administrador à conta do Merchant Center.
Sobre o campo de e-mail
A comunicação eficaz é fundamental. O Google envia atualizações importantes, avisos de serviço obrigatórios (MSAs, na sigla em inglês), pesquisas de desenvolvedores e outras oportunidades relacionadas à API Merchant. O gerenciamento adequado de contatos garante que essas informações cheguem às pessoas certas.
- Propósito: o Google usa esse endereço de e-mail como um contato principal para comunicações relacionadas à API.
- E-mail de quem: esse precisa ser o endereço de e-mail de um desenvolvedor individual ou um contato técnico principal responsável pela integração da API.
- Práticas recomendadas:
- FAÇA: use o endereço de e-mail corporativo de uma pessoa.
- NÃO FAÇA: use aliases de grupos gerais ou e-mails de contas de serviço. As comunicações são destinadas a destinatários humanos.
O recurso users para gerenciamento de contatos
Embora o endereço de e-mail na chamada de registro defina um contato inicial, a
maneira mais robusta de gerenciar contatos e permissões é usando a API Merchant
accounts.users
recurso ou as configurações de gerenciamento de usuários na interface do Merchant Center. Para mais
informações sobre como usar o Merchant Center, consulte
Gerenciar pessoas na sua conta.
Aproveite esses recursos da seguinte maneira:
- Adicionar todos os desenvolvedores: adicione os desenvolvedores que trabalham na integração da API como usuários da conta do Merchant Center.
- Atribuir o papel
API_DEVELOPER: além dos papéis padrão (Administrador, Padrão), você pode atribuir aos usuários o papelAPI_DEVELOPER. Em particular, atribua esse papel aos usuários que precisam receber comunicações relacionadas à API. É possível combiná-lo com outros papéis. - Benefícios:
- Separação clara: desvincula o gerenciamento de contatos da API do registro único.
- Flexibilidade: atualize os contatos à medida que os membros da equipe mudam.
- Comunicação direcionada: garante que as notícias específicas da API cheguem às pessoas relevantes.
Mesmo que você tenha fornecido um endereço de e-mail durante o registro, recomendamos gerenciar os contatos da API adicionando usuários com o papel API_DEVELOPER.
Referências
Para ver mais informações, consulte os seguintes tópicos: