Para usar a API Merchant de forma eficaz, é importante entender os conceitos de registro, autenticação e autorização. Eles têm finalidades distintas 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. Não é possível usar chaves de API para autenticação, e isso resulta em erros de autenticação. 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 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 os vincula aos IDs de 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.
Registro
O processo de registro é crucial para que seu aplicativo possa usar a API Merchant. O que você precisa saber:
Pré-requisitos
Para se registrar e usar a API Merchant, é necessário:
- Conta do Merchant Center: você precisa 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 Google OAuth Playground e o APIs Explorer usam projetos na nuvem compartilhados do Google que pertencem ao Google. Não é possível se registrar com projetos compartilhados porque:
- Elas são destinadas a testes e exploração, não para identidade de aplicativos de produção.
- Registrar esses dados implicaria uma vinculação entre a ferramenta compartilhada e seus dados específicos do Merchant Center, o que pode resultar em comunicações indesejadas.
Seu aplicativo precisa de um projeto dedicado do Google Cloud para que as comunicações da API Merchant que o Google envia para você permaneçam relevantes para seu uso real.
No entanto, é possível usar os apps da Web OAuth Playground e 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
O ID do projeto e o número do projeto estão disponíveis 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 método
registerGcp
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 é essencial. O Google envia atualizações importantes, avisos obrigatórios de serviço (MSAs, na sigla em inglês), pesquisas para desenvolvedores e outras oportunidades relacionadas à API Merchant. O gerenciamento adequado de contatos garante que elas cheguem às pessoas certas.
- Finalidade: o Google usa esse endereço de e-mail como contato principal para comunicações relacionadas à API.
- De quem é o e-mail: precisa ser o endereço de e-mail de um desenvolvedor individual ou de um contato técnico importante 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 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 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 como usar o Merchant Center, consulte
Gerenciar pessoas na sua conta.
Aproveite esses recursos da seguinte maneira:
- Adicione todos os desenvolvedores: adicione os desenvolvedores que trabalham na integração da API como usuários da conta do Merchant Center.
- Atribuir a função
API_DEVELOPER: além das funções padrão (Administrador, Padrão), é possível atribuir aos usuários a funçãoAPI_DEVELOPER. Em particular, atribua essa função aos usuários que devem receber comunicações relacionadas à API. É possível combiná-lo com outros papéis. - Benefícios:
- Separação clara: separa o gerenciamento de contatos da API do registro único.
- Flexibilidade: atualize os contatos conforme os membros da equipe mudam.
- Comunicação direcionada: garante que as notícias específicas da API sejam enviadas à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: