Para usar a API Merchant com eficiência, é importante entender os conceitos de registro, autenticação e autorização. Elas 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 uma finalidade 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. Ela responde à pergunta "O que você pode fazer?" com base nas funções e permissões concedidas ao usuário autenticado na conta do Merchant Center. Por exemplo, um usuário pode ter autorização para ler dados de produtos, mas não para modificar as configurações da conta.
- Registro: em relação à API Merchant, esse é um processo de configuração único que permite ao Google enviar avisos importantes sobre os serviços para as contas de comerciante que você gerencia. O registro adiciona seus endereços de e-mail de desenvolvedor à conta principal do Merchant Center e a vincula aos IDs dos projetos do Google Cloud que você usa para autenticação. Com essa vinculação, seu aplicativo recebe anúncios de serviço de todas as contas de comerciante que você gerencia. Para mais informações, consulte Criar um projeto do Google Cloud.
Registro
O processo de registro é crucial 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: você precisa ter uma conta do Merchant Center.
- Acesso de administrador:a conta de usuário do Google usada 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 de cliente do OAuth 2.0) para a autenticação do aplicativo.
Por que não é possível registrar um projeto compartilhado do Google Cloud
Ferramentas como o Google OAuth Playground e o APIs Explorer usam projetos compartilhados do Google Cloud de propriedade do Google. Não é possível se registrar com projetos compartilhados porque:
- Eles são destinados a testes e exploração, não à identidade de aplicativos de produção.
- Registrá-los implicaria um link entre a ferramenta compartilhada e seus dados específicos do Merchant Center, o que pode resultar em comunicação indesejada.
Seu aplicativo precisa ter um projeto dedicado do Google Cloud para que as comunicações da API Merchant que o Google envia a você permaneçam relevantes para seu uso real.
No entanto, é possível usar os webapps do OAuth Playground e do APIs Explorer para usar a API Merchant em experimentos e casos de uso não relacionados à 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 ligação de registro
Registre-se usando o método
registerGcp
na sub-API Accounts
. Essa chamada associa seu número de 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 é essencial. O Google envia atualizações importantes, avisos de serviço obrigatório (MSAs), pesquisas com desenvolvedores e outras oportunidades relacionadas à API Merchant. O gerenciamento adequado de contatos garante que essas mensagens cheguem às pessoas certas.
- Finalidade: o Google usa esse endereço de e-mail como um contato principal para comunicações relacionadas a APIs.
- E-mail de quem: deve ser o endereço de e-mail de um desenvolvedor individual ou de 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 use aliases de grupo gerais ou e-mails de contas de serviço. Nós destinamos as comunicações 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 é usar o recurso
accounts.users
da API Merchant ou as configurações de gerenciamento de usuários na interface do Merchant Center. Para mais informações sobre o uso do Merchant Center, consulte Gerenciar pessoas na sua conta.
Aproveite esses recursos da seguinte forma:
- Adicione todos os desenvolvedores: adicione os desenvolvedores que trabalham na integração da API como usuários da conta do Merchant Center.
- Atribua a função
API_DEVELOPER
: além das funções padrão (Administrador, Padrão), você pode atribuir aos usuários a funçãoAPI_DEVELOPER
. Em especial, atribua essa função aos usuários que precisam receber comunicações relacionadas à API. É possível combinar essa função com outras. - Benefícios:
- Separação clara: desacopla o gerenciamento de contatos da API do registro único.
- Flexibilidade: atualize os contatos à medida que os membros da equipe mudam.
- Comunicação segmentada: 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 a função API_DEVELOPER
.
Referências
Para ver mais informações, consulte os seguintes tópicos: