API Keys

Gerencie chaves de API para integrar a Pagniv no seu sistema. Chaves podem ser criadas para ambiente sandbox ou produção.

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

Criar API Key

POST

/v1/api-keys

Auth

Cria uma nova chave de API. A chave completa é retornada apenas nesta resposta.

Body (JSON)

Parâmetro	Tipo	Obrigatório	Descrição
`environment`	string	Não	SANDBOX (padrão) ou PRODUCTION

Exemplobash

curl -X POST https://api.pagniv.com/v1/api-keys \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "environment": "PRODUCTION"
  }'

Resposta 201JSON

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "sk_production_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "environment": "PRODUCTION",
    "isActive": true,
    "createdAt": "2026-01-15T08:00:00Z"
  }
}

Listar API Keys

GET

/v1/api-keys

Auth

Retorna todas as API keys do merchant. Chaves são parcialmente mascaradas.

Resposta 200JSON

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "sk_production_****o5p6",
      "environment": "PRODUCTION",
      "isActive": true,
      "lastUsedAt": "2026-01-15T10:30:00Z",
      "createdAt": "2026-01-15T08:00:00Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "key": "sk_sandbox_****85dc",
      "environment": "SANDBOX",
      "isActive": true,
      "lastUsedAt": null,
      "createdAt": "2026-01-14T12:00:00Z"
    }
  ]
}

Revogar API Key

DELETE

/v1/api-keys/{id}

Auth

Revoga uma API key. A chave deixa de funcionar imediatamente.

Exemplobash

curl -X DELETE https://api.pagniv.com/v1/api-keys/{id} \
  -H "Authorization: Bearer {token}"

Usando API Keys

API keys podem ser usadas como alternativa ao JWT para integrações server-to-server. Envie a chave no header:

Header de autenticação via API Key

X-API-Key: sk_production_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Exemplo com cURLbash

curl https://api.pagniv.com/v1/charges \
  -H "X-API-Key: sk_production_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"

Boas práticas

Nunca exponha API keys em código frontend ou repositórios públicos
Use chaves de sandbox para desenvolvimento e testes
Rotacione chaves periodicamente e revogue as não utilizadas
Use variáveis de ambiente para armazenar as chaves