---
title: API REST – Référence complète (OpenAPI)
description: "Toutes les opérations de l'API Kafinea sont décrites dans une référence unique : paramètres, types, valeurs acceptées, droits nécessaires et exemples de réponse. Elle existe sous deux formes, tenues à jour à chaque évolution de l'API. --- ## Pour un…"
url: "https://www.kafinea.com/fr/documentation/api/api-rest-reference-complete/"
updated: "2026-11-15"
category: Intégrations / API
---

# API REST – Référence complète (OpenAPI)

Toutes les opérations de l'API Kafinea sont décrites dans une référence unique : paramètres, types,
 valeurs acceptées, droits nécessaires et exemples de réponse. Elle existe sous deux formes, tenues à
 jour à chaque évolution de l'API.

---

## Pour un développeur : la référence interactive

**[Ouvrir la référence de l'API](https://www.kafinea.com/fr/reference-api/)**

Les opérations y sont classées par domaine (enregistrements, requêtes, documents, comptabilité,
 paramétrage…), avec une recherche. Chaque opération affiche :

- sa méthode HTTP et ses paramètres, obligatoires ou facultatifs ;
- un exemple d'appel prêt à copier, en `curl` et dans les principaux langages (PHP, Python,
   JavaScript, Java, C#…) ;
- un exemple de réponse ;
- le badge **Administrateur** lorsqu'elle est réservée aux administrateurs de l'instance.

Choisissez le nom de votre instance dans le champ **Serveur** : les exemples d'appel l'utilisent
 directement.

---

## Pour vos outils et vos agents IA : la spécification OpenAPI

**Adresse stable de la spécification :** `https://www.kafinea.com/fr/api/openapi.json`

Ce fichier suit la norme **OpenAPI 3.1**, lue par la plupart des outils du marché :

- **générateurs de clients** : produisez une bibliothèque cliente typée dans votre langage ;
- **clients HTTP et outils de test** : importez le fichier pour obtenir une collection de requêtes
   prête à l'emploi ;
- **agents IA** : donnez cette adresse à votre agent, il y trouve chaque opération, ses paramètres
   et leurs règles.

L'adresse ne change pas : elle mène toujours à la dernière version publiée.

---

## Lire la spécification

L'API passe par un point d'entrée unique, `webservice.php`. Chaque opération y est décrite avec un
 chemin de la forme `/webservice.php?operation=<nom>`, qui est aussi l'URL réellement appelée.

| Élément | Où le trouver dans la spécification |
| --- | --- |
| Session | Le schéma de sécurité `session` : paramètre `sessionName`, obtenu avec `login` |
| Paramètres d'une opération GET | Dans l'URL (`in: query`) |
| Paramètres d'une opération POST | Dans le corps du formulaire (`application/x-www-form-urlencoded`) |
| Paramètre de type objet ou liste | Envoyé sous forme de texte JSON (`contentMediaType: application/json`) ; sa structure est dans `contentSchema` |
| Réservée aux administrateurs | Extension `x-kafinea-access: admin` |
| Opération de lecture ou d'écriture | Extension `x-kafinea-scope` : `read`, `write` ou `configure` |

Les champs des modules dépendent du paramétrage de chaque instance (champs personnalisés, champs
 activés) : la spécification décrit les opérations, et `describe` renvoie les champs exacts de votre
 instance.

---

## Références associées 🔗

- [Introduction à l'API](https://www.kafinea.com/fr/documentation/api/api-rest-introduction/)
- [Authentification](https://www.kafinea.com/fr/documentation/api/api-rest-authentification/)
- [Requêtes et interrogation](https://www.kafinea.com/fr/documentation/api/api-rest-requetes-et-interrogation/)
- [Import en masse (upsert)](https://www.kafinea.com/fr/documentation/api/api-rest-import-en-masse/)
