Autenticação e limites

Obtenha uma chave de API na seção Integrações (Integrations).

Recursos

• Gestão de cobranças: criação, cancelamento, verificação de status
• Gestão de pagamentos: listas de pagamentos, vinculação de um pagamento a uma cobrança
• Estatísticas: dados agregados por projeto, período, carteira e mais
• Faturamento: taxas dos projetos, saldos

Limites

• Frequência de requisições: no máximo 1 requisição por segundo por chave
• Número de chaves: 10 por conta

Autorização das requisições

Passe a sua chave de API no cabeçalho Authorization para autorizar cada requisição à API.

Um exemplo do cabeçalho Authorization em uma requisição à API:

curl -X POST https://api.bitsby.app/invoices/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay"

Resposta do servidor

O servidor da API sempre responde em JSON. Use o parâmetro result para saber se a requisição teve sucesso.

Um exemplo de resposta para uma requisição bem-sucedida:

{
    "result": "success",
    "data": .....
}

Um exemplo de resposta para um erro:

{
    "result": "error",
    "data": "Requests too frequent"
}