Skip to main content
A API é autenticada por chave de API. Cada chave pertence a uma loja e é gerada no painel, em Integrações → API.

Gerando uma chave

No painel, vá em Integrações → API → Nova chave. A chave completa (gp_live_… ou gp_test_…) é exibida uma única vez — copie e guarde em local seguro. Guardamos apenas um hash; não conseguimos mostrá-la de novo.

Enviando a chave

Envie a chave no header Authorization como Bearer token:
Como alternativa, o header x-api-key também é aceito:

Boas práticas

Nunca exponha a chave no navegador. A chave de API dá acesso total à sua loja. Use-a somente no seu servidor. Para cobrar no front-end, use a checkoutUrl retornada pela cobrança.
  • Revogue chaves comprometidas no painel — o acesso é cortado na hora.
  • Use chaves de teste (gp_test_) em desenvolvimento e live (gp_live_) em produção.
  • Uma requisição sem chave válida retorna 401: