Autenticação da API
Autentique-se na API do Spark!
Última atualização: 2026-01-19
A API do Spark! usa chaves de API para autenticação. Inclua sua chave no cabeçalho Authorization de cada solicitação.
Como obter sua chave de API
- Acesse Settings → API → API Keys
- Clique em "Create API Key"
- Dê um nome à chave (por exemplo, "Produção" ou "Homologação")
- Defina as permissões (somente leitura ou leitura e gravação)
- Copie e armazene a chave com segurança
Mantenha as chaves em segredo
As chaves de API dão acesso completo aos seus dados do Spark!. Nunca as exponha em código do lado do cliente, repositórios públicos ou logs.
Como usar sua chave de API
Inclua a chave de API no cabeçalho Authorization:
Authorization: Bearer YOUR_API_KEY
Limites de requisições
As requisições à API têm limites:
- Padrão — 100 requisições por minuto
- Operações em massa — 10 requisições por minuto
- Webhooks — Sem limite (saída)
Cada resposta inclui cabeçalhos de limite de requisições:
X-RateLimit-Limit— Máximo de requisições permitidoX-RateLimit-Remaining— Requisições restantesX-RateLimit-Reset— Timestamp Unix de quando o limite é reiniciado
Tratamento de erros
Os erros da API retornam códigos de status HTTP padrão:
- 400 — Solicitação inválida (parâmetros inválidos)
- 401 — Não autorizado (chave de API inválida ou ausente)
- 403 — Proibido (permissões insuficientes)
- 404 — Não encontrado
- 429 — Excesso de requisições (limite atingido)
- 500 — Erro do servidor
Ambientes
- Produção —
https://api.chargezen.com/spark/v1 - Sandbox —
https://sandbox.chargezen.com/spark/v1
Testes no sandbox
Use o ambiente sandbox para testes. Ele espelha a produção, mas não afeta dados reais nem aciona pagamentos reais.
Próximos passos
Artigos relacionados
Esta página foi útil?
Precisa de mais ajuda? Fale com o suporte