Todas as requisições à API pública do ImperiumPay Gateway requerem autenticação via API Keys.
API Keys
As API Keys são compostas por dois componentes:
- Chave Pública (Public Key): Identifica sua conta
- Chave Privada (Private Key): Autentica suas requisições
Obtendo suas API Keys
Navegue até API Keys
No menu lateral, navegue até Integrações → Credenciais de API.
Gere um novo par de chaves
Clique em Gerar Nova Chave e confirme a ação.
Guarde suas chaves com segurança
Importante: Guarde a chave privada com segurança, ela não será exibida novamente após a geração.
Recomendamos salvar as chaves em um gerenciador de senhas ou variáveis de ambiente seguras.
Como Usar
Inclua as chaves de API nos cabeçalhos de todas as requisições:
Sua chave pública da API (formato: pk_...)
Sua chave privada da API (formato: sk_...)
Exemplos de Requisição
curl -X GET https://api.imperiumpay.com.br/api/transactions/123 \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui"
Segurança
Importante: Nunca exponha suas chaves de API em código frontend ou repositórios públicos. Sempre use variáveis de ambiente ou serviços de gerenciamento de segredos.
Boas Práticas
- ✅ Armazene as chaves em variáveis de ambiente
- ✅ Use serviços de gerenciamento de segredos (AWS Secrets Manager, HashiCorp Vault, etc.)
- ✅ Rotacione suas chaves regularmente
- ✅ Revogue chaves comprometidas imediatamente
- ❌ Nunca commite chaves em repositórios Git
- ❌ Nunca exponha chaves em código frontend
Erros de Autenticação
401 Unauthorized
Retornado quando as chaves de API são inválidas ou ausentes:
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Chaves de API inválidas ou ausentes"
}
}
403 Forbidden
Retornado quando a operação não é permitida para sua conta:
{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Operação não permitida para esta conta"
}
}
