Goomer API

Appearance

Autenticação ​

A autenticação é um componente essencial para garantir que apenas usuários e sistemas autorizados possam acessar os recursos da API. A Goomer implementa um modelo de autenticação baseado em tokens para proteger os dados dos estabelecimentos e garantir a privacidade das informações.

Parceiros autenticados ​

Parceiros validados e reconhecidos oficialmente pela Goomer possuem um modelo de autenticação privilegiado, que permite maior acesso à API com limites de uso mais amplos.

Para realizar autenticação como parceiro oficial, é necessário incluir nas requisições:

  • O header x-partner-key: chave de identificação do parceiro
  • O header x-partner-token: token de acesso exclusivo fornecido pela Goomer
  • O token do estabelecimento no header de autorização (Authorization: Bearer {token})

Essa combinação de credenciais permite que parceiros oficiais acessem a API com menos restrições e limites de uso mais elevados, permitindo integrações mais robustas e eficientes.

Exemplo de headers para parceiros reconhecidos:

plaintext
Authorization: Bearer {token-do-estabelecimento}
x-partner-key: {sua-partner-key}
x-partner-token: {seu-partner-token}

Parceiros não autenticados ​

A API também está disponível para integrações que não são de parceiros oficiais da Goomer. Neste caso, a autenticação é simplificada, exigindo apenas o token do estabelecimento.

Para autenticação sem parceria oficial:

  • Inclua apenas o token do estabelecimento no header de autorização (Authorization: Bearer {token})

Exemplo de header para não-parceiros:

plaintext
Authorization: Bearer {token-do-estabelecimento}

Neste modelo de autenticação, o acesso à API é mais limitado e está sujeito a regras mais rigorosas de rate limiting para proteger a infraestrutura e garantir a qualidade do serviço para todos os usuários.

Para obter mais informações sobre os limites de requisições e as regras de rate limiting, consulte a página de limites de uso.

Obtenção de Credenciais ​

Para obter as credenciais de autenticação da API:

  • Token do estabelecimento: Gerado no painel de configurações da loja na plataforma Goomer
  • Credenciais de parceiro: Fornecidas pela equipe da Goomer após processo de validação e aprovação da parceria

Segurança ​

As credenciais de autenticação são exclusivas e confidenciais. Recomendamos:

  • Nunca compartilhar suas credenciais de API
  • Armazenar tokens de forma segura, utilizando variáveis de ambiente ou cofres de senhas
  • Implementar mecanismos de detecção de uso indevido