Aller au contenu principal

Authentification et limites

Obtenez une clé d'API dans la section Intégrations (Integrations).

Possibilités

  • Gestion des factures : création, annulation, vérification du statut
  • Gestion des paiements : liste des paiements, association d'un paiement à une facture
  • Statistiques : données agrégées par projet, période, portefeuille et plus
  • Facturation : tarifs des projets, soldes

Limites

  • Fréquence des requêtes : au plus 1 requête par seconde et par clé
  • Nombre de clés : 10 par compte

Autorisation des requêtes

Passez votre clé d'API dans l'en-tête Authorization pour autoriser chaque requête à l'API.

Un exemple d'en-tête Authorization dans une requête à l'API :

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

Réponse du serveur

Le serveur de l'API répond toujours en JSON. Utilisez le paramètre result pour savoir si la requête a réussi.

Un exemple de réponse pour une requête réussie :

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

Un exemple de réponse pour une erreur :

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