Pagnivpagniv
Dashboard

API Keys

Crie, gerencie e use suas chaves de API com segurança.

Importante

API keys são exibidas apenas uma vez no momento da criação. Salve-as em local seguro.

Como usar

Envie sua chave no header X-API-Key em todas as requisições à API:

Sua primeira requisição
bash
curl -X POST https://api.pagniv.com/v1/charges \
  -H "X-API-Key: sk_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 15000,
    "description": "Pedido #1234"
  }'

Prefixos

Sandbox

Prefixo: sk_sandbox_

Descrição: Testes. Nenhuma transação real é processada

Produção

Prefixo: sk_live_

Descrição: Transações reais via Pix

Formato da chave

Completask_live_7f3a1b9c4e2d8f6a0b5c3e7d9a1f4b8e2c6d0a3e5f7b9c1d4a6e8f0b2c4d6e
Mascaradask_live_****9c8a83ae

A chave completa aparece apenas uma vez, no momento da criação. Depois, é exibida mascarada no dashboard.

Gerenciar chaves

Crie, revogue e rotacione chaves de API diretamente no dashboard:

  1. Acesse Dashboard → Integrações → Chaves de API
  2. Clique em Nova chave e selecione o ambiente (Sandbox ou Produção)
  3. Escolha as permissões (escopos) e, se quiser, restrinja por IP e defina uma validade
  4. Copie a chave gerada. Ela não será exibida novamente
  5. Para revogar, clique no botão de revogar ao lado da chave

Permissões, IP e validade

  • Permissões (escopos): limite a chave a cobranças, carteira e/ou saques. O preset "Somente cobranças" gera uma chave que não pode sacar, reduzindo o risco se ela vazar. Escopos disponíveis: charges:write, charges:read, wallet:read, withdrawals:write.
  • Restrição por IP: informe IPs ou faixas CIDR (IPv4/IPv6) autorizados. Chamadas de outros IPs recebem 403. Vazio = qualquer IP.
  • Validade: defina uma expiração opcional. Depois da data, a chave para de funcionar (401) e você gera uma nova.

Boas práticas

  • Nunca exponha keys em código frontend ou repositórios públicos
  • Use sk_sandbox_ para desenvolvimento e testes
  • Rotacione keys periodicamente
  • Armazene chaves em variáveis de ambiente no servidor