Documentation API

Accéder à l'API REST Daxium-Air pour des intégrations sur mesure et une automatisation avancée.

Daxium-Air propose une API REST complète pour les développeurs qui souhaitent créer des intégrations sur mesure ou automatiser des workflows de manière programmatique.

Ce que vous pouvez faire

• Lire les fiches, les structures et les données utilisateurs
• Créer et mettre à jour des fiches de manière programmatique
• Rechercher des fiches avec des filtres avancés
• Gérer les utilisateurs et les groupes
• Générer des rapports à la demande

Authentification

L'API utilise une authentification par jeton OAuth. Vous aurez besoin d'une clé API et d'un secret générés depuis le back office Daxium-Air, ainsi que d'un nom d'utilisateur et d'un mot de passe, pour générer un jeton OAuth. Ce jeton est ensuite utilisé pour authentifier vos requêtes.

1. Générez une clé API et un secret dans Webservices > Clés d'API puis en cliquant sur "+ Nouveau"
2. Entrez une description de la clé API pour la nommer, et sauvegardez

Permissions

Pour utiliser l'API, l'utilisateur authentifié doit avoir la licence Mobile activée. Les droits sur les formulaires, les fiches, les groupes, etc. sont hérités de cet utilisateur, exactement comme dans l'application.

Les licences Lecteur Web et Contributeur Web n'ont aucun effet sur l'accès à l'API. Par exemple, un utilisateur disposant à la fois de la licence Mobile et de la licence Lecteur Web pourra tout de même créer et modifier des fiches via l'API.

Prise en main

1. Générez un jeton d'authentification à l'aide de la clé API et du secret, ainsi que du nom d'utilisateur et du mot de passe de l'utilisateur pour lequel vous souhaitez vous authentifier
2. Incluez le jeton d'authentification dans l'en-tête Authorization de vos requêtes
3. Consultez la référence de l'API pour connaître les points de terminaison disponibles

La référence complète de l'API est disponible dans la section Référence API de ce site de documentation.