API
Les API de BunnyDoc — comment la Signature électronique et la Facturation se répartissent en deux API distinctes, et par où commencer.
L'API de BunnyDoc suit la même séparation que l'application : la Signature électronique et la Facturation sont deux API distinctes. Elles vivent sous un même compte et partagent l'authentification, mais possèdent leurs propres endpoints et leurs propres ressources. Il n'existe pas d'API combinée.
API Signature électronique
Enveloppes, signataires, champs, modèles, blocs de document et paiements encaissés pendant la signature.
API Facturation
Factures, devis, avoirs, factures récurrentes, inventaire, dépenses et paiements.
Choisir la bonne API
La distinction qui pose problème est la même que dans l'application : un tableau de facture construit dans un document à signer relève de la Signature électronique, pas de la Facturation.
| Ce que vous voulez faire | Utilisez |
|---|---|
| Envoyer un document à signer | API Signature électronique |
| Ajouter un tableau de prix ou de facture à un document à signer | API Signature électronique |
| Encaisser un signataire pendant la signature | API Signature électronique |
| Créer une facture autonome avec son numéro et son statut | API Facturation |
| Envoyer un devis ou un avoir | API Facturation |
| Gérer produits, stock ou dépenses | API Facturation |
Les contacts, utilisateurs, rôles et paramètres d'entreprise sont partagés : vous y accédez de la même façon depuis l'une ou l'autre API.
Authentification
Les deux API utilisent les mêmes identifiants, émis par entreprise. Une requête porte l'identifiant et l'entreprise pour laquelle elle agit ; chaque réponse est limitée à cette entreprise.
Gardez les identifiants côté serveur
Les identifiants d'API agissent au nom de toute votre entreprise. Ne les intégrez jamais dans un navigateur, une application mobile ou un client que vous ne contrôlez pas.
Conventions
- JSON en entrée et en sortie — envoyez et attendez
application/json. - Limité à une entreprise — chaque ressource appartient à une entreprise et les requêtes ne franchissent jamais cette limite.
- Les mêmes permissions que dans l'application — un identifiant ne peut faire que ce que son rôle autorise. Voir Utilisateurs et rôles.
- Limitation de débit — les rafales soutenues sont bridées ; patientez puis réessayez.
Référence des endpoints
La référence endpoint par endpoint est publiée dans la section de chaque API : commencez par l' API Signature électronique ou l'API Facturation.
Comment créer des modèles d'autorisations ?
Créez des ensembles réutilisables d'autorisations que vous pouvez appliquer aux membres de l'équipe au lieu de configurer l'accès clé par clé.
API de signature électronique
Envoyez des documents à signer directement depuis vos propres systèmes : échangez une clé d'API contre un jeton, créez des enveloppes à partir de modèles, gérez des contacts et récupérez les liens de signature via une API REST simple.