View Categories

API REST – Introduction

1 minutes

API REST – Introduction #

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]"
  }
}

Récapitulatif des opérations #

Opération Méthode Description
getchallenge GET Obtenir un token de connexion
login POST Se connecter
logout POST Se déconnecter
extendsession GET Prolonger la session
listtypes GET Lister les modules disponibles
describe GET Décrire les champs d’un module
create POST Créer une entité
retrieve GET Récupérer une entité
update POST Mettre à jour une entité
delete POST Supprimer une entité
query GET Interroger la base de données
query_related GET Interroger les listes connexes
add_related POST Ajouter une relation entre entités
getPicklistValues GET Récupérer les valeurs d’une liste déroulante
setPicklistValues POST Modifier les valeurs d’une liste déroulante
FileUpload POST Télécharger un fichier
files_retrieve GET Récupérer un fichier

Références associées 🔗 #