Diretrizes do Postman para APIs

O Postman melhora significativamente a capacidade de testar e entender as APIs do comerciante, oferecendo uma interface fácil de usar para criar, enviar e analisar solicitações HTTP. É fácil criar e modificar várias chamadas de API (GET, POST, PUT, DELETE) para diferentes endpoints, ajustando parâmetros, cabeçalhos e corpos de solicitação para simular cenários do mundo real.

A apresentação clara das respostas da ferramenta, incluindo códigos de status, cabeçalhos e payloads, permite uma verificação rápida do comportamento da API e ajuda na depuração de problemas. Essa abordagem estruturada acelera o ciclo de vida de desenvolvimento, melhora a qualidade da API e aprofunda a compreensão dos recursos e das complexidades da API Merchant.

Visão geral

Para usar a coleção MAPI do Postman na sua instância, siga algumas etapas para configurar o ambiente primeiro. Confira as instruções detalhadas de como fazer isso.

Para mais informações sobre a plataforma, consulte a descrição do Postman.

1. Configuração da conta de serviço

Você vai receber o serviceAccountKey e a api_key.

  1. Para etapas detalhadas, siga como usar uma conta de serviço para acessar a API.
  2. No seu projeto do Google Cloud > Credenciais > Criar credenciais > Conta de serviço
  3. Preencha o formulário e clique em Criar e continuar.
  4. Selecione a função Proprietário e clique em Continuar.
  5. Clique em Concluir.
  6. Para fazer o download da chave JSON, siga estas etapas:
    1. Clique no e-mail da conta de serviço que você acabou de criar (algo como {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
    2. Clique na guia Chaves.
    3. Clique em Adicionar chave > Criar chave.
    4. Selecione JSON e clique em Criar para fazer o download do JSON.

AVISO: você só pode fazer o download da chave uma vez. Se você perder, será necessário criar uma nova e excluir esta.

  1. Abra o Merchant Center.
  2. Em Configurações > Acesso e serviços, clique em Pessoas e acesso.
  3. Clique em Adicionar pessoa e use o ID da conta de serviço como o endereço de e-mail do novo usuário.

2. Configuração do Postman

  1. Baixe o modelo JSON do ambiente do Postman.
  2. Faça o download do JSON da coleção MAPI do Postman.
  3. Faça login no Postman ou crie uma nova conta
  4. Importar modelo de ambiente do Postman
    1. Copie o JSON completo em Environment > MyAccount > serviceAccountKey
    2. Copie sua private_key do JSON para Environment > MyAccount > api_key da coleção.
  5. Importar JSON da coleção do Postman da MAPI
  6. Selecione o ambiente no canto superior direito.

3. Registro de desenvolvedor

Vincule sua conta do Merchant Center ao projeto do Google Cloud registrando-se como desenvolvedor. Os usuários com a função de desenvolvedor de API vão receber comunicações sobre a API, incluindo anúncios obrigatórios de serviços, pesquisas para desenvolvedores e oportunidades.

  1. Abra Postman > Collections > Merchant API Official
  2. Abra accounts_v1 > accounts > accounts.developerRegistration > registerGcp
  3. Substitua o marcador {account} no caminho pelo ID da sua MC.
  4. Substitua o marcador de posição {email} no corpo da mensagem pelo seu endereço de e-mail.
  5. Clique em Enviar para executar o registro.
  6. Se tudo foi feito corretamente, você vai receber uma resposta JSON de confirmação como esta: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Testar a API Merchant no Postman

  1. Abra Postman > Collections > Merchant API Official > accounts_v1 > accounts > list
  2. Clique em Enviar.
  3. Se tudo foi feito corretamente, você vai receber uma resposta JSON de confirmação como esta: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }