{"id":441543,"date":"2026-04-03T02:43:22","date_gmt":"2026-04-03T00:43:22","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-operations-crud\/"},"modified":"2026-04-23T01:47:45","modified_gmt":"2026-04-22T23:47:45","password":"","slug":"api-rest-operations-crud","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-operations-crud\/","title":{"rendered":"API REST – Op\u00e9rations CRUD"},"content":{"rendered":"
\n

ListTypes \u2014 Lister les modules disponibles<\/h2>\n

Cette op\u00e9ration retourne tous les modules accessibles via l’API.<\/p>\n

\n

GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n

\n\n\n\n\n\n\n
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre listtypes<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

Exemple curl :<\/strong><\/p>\n

curl "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=listtypes&sessionName=YOUR_SESSION_ID"\n<\/code><\/pre>\n
\n
Describe \u2014 D\u00e9crire un module<\/h2>\n
Cette op\u00e9ration permet de conna\u00eetre les champs d’un module (type, caract\u00e8re obligatoire) et les actions disponibles.<\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre describe<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\noui<\/td>\nNom du module (ex : Contacts<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Exemple curl :<\/strong><\/p>\n
curl "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=describe&sessionName=YOUR_SESSION_ID&elementType=Contacts"\n<\/code><\/pre>\n
\n
Retrieve \u2014 R\u00e9cup\u00e9rer une entit\u00e9<\/h2>\n
R\u00e9cup\u00e8re une entit\u00e9 sp\u00e9cifique par son ID Webservice (ex : 21x3456<\/code>).<\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre retrieve<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
id<\/code><\/td>\nstring<\/td>\noui<\/td>\nID Webservice de l’entit\u00e9 (ex : 21x3456<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Exemple curl :<\/strong><\/p>\n
curl "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=retrieve&sessionName=YOUR_SESSION_ID&id=21x3456"\n<\/code><\/pre>\n
\n
Create \u2014 Cr\u00e9er une entit\u00e9<\/h2>\n
Cr\u00e9e une nouvelle entit\u00e9 dans un module. Tous les champs obligatoires doivent \u00eatre inclus. Les valeurs de champs li\u00e9es \u00e0 d’autres modules doivent utiliser le format Webservice IDs (ex : 21x3456<\/code>).<\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre create<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
element<\/code><\/td>\nJSON<\/td>\noui<\/td>\nObjet JSON de l’entit\u00e9 (fieldname: fieldvalue<\/code>)<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\noui<\/td>\nNom du module (ex : Contacts<\/code>)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Exemple curl :<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d "operation=create" \\\n  -d "sessionName=YOUR_SESSION_ID" \\\n  -d 'element={"lastname":"Dupont","email":"dupont@example.com","assigned_user_id":"19x1"}' \\\n  -d "elementType=Contacts"\n<\/code><\/pre>\n
\n
Attention !<\/strong> Pour les modules de type inventaire (factures, devis, commandes, etc.), il est obligatoire d’inclure les champs suivants dans l’objet element<\/code> :<\/p>\n