> For the complete documentation index, see [llms.txt](https://ksaar.gitbook.io/ksaar-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ksaar.gitbook.io/ksaar-documentation/connexions/api-ksaar.md).

# 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](https://api.ksaar.co/open-api).

### 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.**

<figure><img src="/files/lGwN6FD4Wl8J4E9mpYxn" alt=""><figcaption></figcaption></figure>

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

{% hint style="warning" %}
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.
{% endhint %}

<figure><img src="/files/RL5mwjc9VMA3xGh1QZDg" alt=""><figcaption></figcaption></figure>

### 👉 Utilisation de vos identifiants

Une fois vos identifiants créés, vous pouvez les rentrer dans le [swagger Ksaar](https://api.ksaar.co/open-api) pour y faire votre premier call :&#x20;

1️⃣ Cliquez sur Authorize.

<figure><img src="/files/85dw9XHQ8UCHbhXVtD8H" alt=""><figcaption></figcaption></figure>

2️⃣ Entrez les identifiants de votre clé API.&#x20;

<figure><img src="/files/3hnk4fHkmg5siXA7XlhP" alt=""><figcaption></figcaption></figure>

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](https://api.ksaar.co/open-api) et cliquez sur **Try it out** puis sur **Execute**.

#### Exemple pour le GET "/v1/applications"

<figure><img src="/files/iMcxKXfoyLn6iT90I7Fw" alt=""><figcaption><p>Test des identifiants sur le GET "/v1/applications" </p></figcaption></figure>

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.&#x20;

<figure><img src="/files/HVbz54voFg9wcNoYxFL9" alt=""><figcaption><p>Résultats du test</p></figcaption></figure>

### 📖 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 :**

<figure><img src="/files/IMnH5lnsg4QDd88G1dvQ" alt="" width="375"><figcaption></figcaption></figure>

#### 📤 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)](/ksaar-documentation/connexions/api-ksaar/recherche-denregistrements-filtres-tri-et-pagination.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ksaar.gitbook.io/ksaar-documentation/connexions/api-ksaar.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.