Profitez des API REST exposées sur HTTP(s) pour pousser ou tirer des données de Kafinea et les intégrer à des applications tierces. Vous êtes libre de choisir la bibliothèque de votre choix pour travailler avec ces API.
Principes généraux #
L’API Kafinea est une API REST : vous communiquez directement avec votre instance Kafinea et chaque requête est unique et indépendante. Rien n’est stocké en cache.
- Protocole : HTTP(s)
- Méthodes : GET et POST
- Format de réponse : JSON
- URL de base :
https://apps.kafinea.com/{VotreInstance}/webservice.php
Format des réponses #
Réponse positive #
{
"success": true,
"result": {
// ...
}
}
Réponse négative #
{
"success": false,
"error": {
"message": "[STRING]",
"code": "[STRING]"
}
}
Toutes les opérations #
La liste complète des opérations, avec leurs paramètres, leurs droits et des exemples de réponse,
se trouve dans la référence complète de l’API : une
référence interactive pour les développeurs et une
spécification OpenAPI pour vos outils et vos agents IA.
Noms d’opération : plus de préfixe #
Les noms d’opération ne portent aucun préfixe : ils s’écrivent en minuscules, les mots séparés par
des tirets bas. Rien à retenir de particulier, une opération ajoutée par Kafinea se nomme comme une
opération standard.
Deux opérations ont changé de nom et répondent aux deux noms pendant la période de transition :
| Ancien nom | Nouveau nom | Ancien nom accepté jusqu’au |
|---|---|---|
mds_document_pdf |
document_pdf |
30 novembre 2026 |
mds_invoice_facturx |
invoice_facturx |
30 novembre 2026 |
Les paramètres et les réponses sont identiques : il suffit de changer la valeur de operation dans
vos appels. Passé cette date, l’ancien nom n’est plus publié.
Qui peut appeler quoi #
Les opérations courantes (describe, query, retrieve, create, update, delete, les
relations, les fichiers) sont ouvertes à tout compte disposant d’une clef d’accès. Chacune applique
les droits du compte utilisé : profil, rôle, partage des enregistrements. Un compte restreint ne
voit et n’écrit à travers l’API que ce qu’il verrait et écrirait dans l’interface.
Les opérations d’intégration et de paramétrage sont en revanche réservées aux comptes
administrateurs : traitements par lot (mass_upsert, mass_delete), champs, blocs, listes de
choix, paramétrage fiscal, et la lecture des champs non activés avec describe. La
référence complète les signale par le badge Administrateur.
Un compte non administrateur qui appelle l’une de ces opérations reçoit un refus explicite nommant
l’opération, et aucune donnée. Écrire un enregistrement à la fois reste possible pour lui avec
create, update et delete, qui appliquent ses propres droits.