🌐API Ksaar

L'API Ksaar vous permet d'interagir avec vos données et vos workflows depuis des outils externes.

Elle peut notamment être utilisée pour :

• Synchroniser des données avec un système tiers.

• Alimenter Ksaar depuis une application externe.

• Lire ou mettre à jour des enregistrements automatiquement.

• Déclencher des actions depuis des outils d'automatisation comme Make ou Zapier.

• Construire des intégrations personnalisées avec votre système d'information.

Pour accéder à la documentation interactive (Swagger) 👉 cliquez sur ce lien.

Avant de commencer

Pour appeler l'API Ksaar, vous devez disposer d'une clé API.

Chaque clé API est associée à une application et permet d'authentifier les requêtes effectuées depuis une application ou un outil externe.

Nous recommandons de créer une clé API dédiée pour chaque intégration (Make, Zapier, script personnalisé, application interne, ...). Cela facilite la gestion des accès et permet de révoquer une intégration sans impacter les autres.

🆔 Création d'identifiants

Pour utiliser l'API Ksaar, vous devez créer des identifiants :

1️⃣ Sur Ksaar, ajoutez une nouvelle clé API en allant dans les Paramètres puis dans Connectors.

2️⃣ Définissez le nom de votre nouvelle clé API.

N'oubliez pas de noter le mot de passe de la clé API car il vous sera montré qu'une seule fois. Si vous le perdez, vous devrez générer une nouvelle clé API.

👉 Utilisation de vos identifiants

Une fois vos identifiants créés, vous pouvez les rentrer dans le swagger Ksaar pour y faire votre premier call :

1️⃣ Cliquez sur Authorize.

2️⃣ Entrez les identifiants de votre clé API.

3️⃣ Validez l'authentification.

Toutes les requêtes exécutées depuis le Swagger utiliseront alors cette clé API.

✅ Vérifier vos identifiants

Pour vérifier que vos identifiants fonctionnent correctement, vous pouvez les tester. Pour cela, choisissez une des actions du swagger Ksaar et cliquez sur Try it out puis sur Execute.

Exemple pour le GET "/v1/applications"

Test des identifiants sur le GET "/v1/applications"

Si les identifiants fonctionnent, vous obtenez une liste avec le nom de vos applications Ksaar, leur identifiant, leur date de création et leur date de dernière modification.

Résultats du test

📖 Aller plus loin

🆔 Retrouver l'identifiant d'un objet

Certains endpoints de l'API utilisent les identifiants techniques des objets Ksaar (applications, workflows, champs).

Pour récupérer l'identifiant d'un objet, cliquez sur le menu ⋯ associé à celui-ci puis sur Copier l'ID.

Par exemple, pour récupérer l'identifiant d'un workflow, ouvrez la vue Data, puis, dans la liste des tables à gauche, cliquez sur le menu ⋯ du workflow concerné et sélectionnez Copier l'ID :

📤 Filtrer, trier et paginer les enregistrements

Pour les cas d'usage avancés de consultation de données, nous recommandons d'utiliser l'endpoint Search Records, qui permet notamment :

• de filtrer les enregistrements

• de trier les résultats

• de paginer les données

👉 Consultez la documentation dédiée : Recherche d'enregistrements (filtres, tri et pagination)