Skip to main content
A API da Chargefy usa API keys server-side. Envie a chave no header Authorization usando o esquema Bearer. 
curl https://api.chargefy.io/v1/customers \
  -H "Authorization: Bearer {{API_KEY}}"
Nunca exponha API keys no browser, em apps mobile ou em código versionado. Faça requisições para a API pública a partir do seu servidor.

​
Chaves de API

Cada organização cria e gerencia suas próprias chaves no dashboard. O token é mostrado uma única vez no momento da criação. As chaves podem ter escopos diferentes:
ScopeUso
readListar e consultar recursos.
writeCriar, atualizar, confirmar, cancelar ou desativar recursos. Inclui read.
adminOperações administrativas reservadas. Inclui read e write.
Use o menor escopo possível para cada integração.

​
Request IDs

Toda resposta da API inclui o header Request-Id com um identificador req_*. Use esse ID para consultar o request no dashboard ou para falar com suporte.

​
Plataformas e organizações conectadas

Se você opera como plataforma, sua API key pertence à organização plataforma. Para atuar em uma organização conectada, envie o header Organization com o ID da organização filha. 
curl https://api.chargefy.io/v1/payment-intents \
  -H "Authorization: Bearer {{PLATFORM_API_KEY}}" \
  -H "Organization: org_123"
Esse header só funciona para organizações conectadas ativas e em endpoints que suportam operação em nome da organização conectada.

​
Respostas comuns

Credencial ausente ou inválida: 
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "type": "authentication_error"
  }
}
Escopo insuficiente: 
{
  "error": {
    "code": "permission_denied",
    "message": "The API key does not have the required scope.",
    "type": "invalid_request_error"
  }
}

​
Próximos passos