Skip to main content
Para usar a API da ZeriqPay, você precisa criar uma API Key no dashboard.

​
Antes de começar

Você precisa ter o 2FA ativo na sua conta para criar uma nova chave.

​
Criar a chave

  1. Acesse o gerenciamento de API Keys.
  2. Clique em Criar nova chave de API.
  3. Dê um nome para a chave. Use um nome que identifique a aplicação ou ambiente, como producao-checkout ou staging.
  4. Selecione os escopos necessários para a integração.
  5. Confirme a criação e copie a API Key exibida.
Você precisa ter o 2FA ativo para criar uma nova API Key.
Guarde a API Key em um lugar seguro. Não a publique no frontend, em repositórios de código ou em mensagens. Use um secret manager ou as variáveis de ambiente do seu servidor.

​
Escolha dos escopos

Conceda somente as permissões necessárias para a aplicação. Evite selecionar escopos amplos quando a integração precisar de apenas uma parte da API. Se os escopos forem alterados depois, revise as permissões usadas pela aplicação e faça uma nova validação em ambiente de teste.

​
Usar a API Key

Envie a chave no header X-API-Key em todas as requisições autenticadas:
Nunca coloque a API Key diretamente no código do frontend. As chamadas autenticadas devem passar pelo seu backend.

​
Checklist de segurança

  • 2FA ativado antes de criar a chave.
  • Nome da chave identificando aplicação e ambiente.
  • Somente os escopos necessários selecionados.
  • Chave armazenada em local seguro.
  • Chave ausente de repositórios, logs e código do frontend.