Votre API
Tout ce que vous pouvez faire dans votre organisation est aussi disponible via son API, avec vos propres accès. La Référence de l'API la décrit.
Chaque organisation a sa propre API : les mêmes actions que dans le tableau de bord, mises à la disposition d’autres logiciels. La Référence de l’API la décrit, opération par opération. Ouvrez-la depuis Technique → Référence de l’API dans la barre latérale.
Seuls les membres de l’organisation peuvent ouvrir sa Référence de l’API, et tous les membres le peuvent.
Ce que montre la référence
Section titled “Ce que montre la référence”- Comment l’appeler : l’adresse sous laquelle se trouve chaque opération, et comment une requête indique qui la fait.
- Groupes : les enregistrements, le modèle de données, la publication, les rôles de données, les départements, les membres, l’organisation et le journal des événements, chacun avec son nombre d’opérations.
- Les enregistrements de chaque entité : un groupe par entité, avec ses propres champs, tels que les a le stage que vous consultez. Basculez entre Preview et Live en haut à droite pour voir l’autre.
- Recherche : trouve des opérations d’après ce qu’elles font, dans tous les groupes.
- Codes d’erreur : chaque erreur a la même forme, avec un code sur lequel un programme peut agir. Cette page les liste, avec la signification de chacun.
- Télécharger le document OpenAPI : toute la description dans un fichier, pour les outils qui lisent le format OpenAPI.
Une opération
Section titled “Une opération”Choisissez une opération pour l’ouvrir. Elle montre l’adresse complète à appeler, ses paramètres, ce qu’il faut envoyer et ce qui est renvoyé, champ par champ, et qui peut l’appeler.
Chaque opération indique aussi jusqu’où elle peut aller :
| Étiquette | Signification |
|---|---|
| Lecture | Consulte seulement. |
| Modification | Modifie quelque chose qui peut être rétabli. |
| Modifie Live | Modifie vos vrais enregistrements dans Live. |
| Irréversible | Supprime ou retire quelque chose. |
| Quitte kvyk.ai | Envoie quelque chose à l’extérieur, comme un e-mail d’invitation. |
Dans quelle langue
Section titled “Dans quelle langue”Les descriptions de la référence, les noms de l’API et les codes d’erreur sont en anglais, quelle que soit la langue du tableau de bord : ils sont écrits pour les développeurs. Ce que l’API répond, par exemple la raison d’un refus, est dans votre langue : celle dans laquelle votre compte lit le tableau de bord, ou sinon celle qu’une requête demande avec Accept-Language.
En votre nom, avec vos accès
Section titled “En votre nom, avec vos accès”Une opération fait exactement ce que vous pourriez faire dans le tableau de bord, rien de plus : les mêmes rôles de données, accès aux champs et vérifications s’appliquent. Tout ce qui est fait via l’API apparaît dans le journal des événements comme le reste.
L’assistant l’utilise aussi
Section titled “L’assistant l’utilise aussi”L’assistant passe par les mêmes opérations. C’est pour cela qu’il peut faire tout ce que vous pouvez faire, et qu’il vous demande de confirmer avant toute opération marquée Modifie Live, Irréversible ou Quitte kvyk.ai. Il peut aussi ouvrir la Référence de l’API pour vous. Voir Vos données et l’assistant.