Une API (Application Programming Interface ou "Interface de Programmation d'Application") est un service qui vous permet de vous interfacer avec une application et d'échanger des informations. En créant une API à partir d'une donnée d'usage vous pourrez ainsi interroger celle-ci et récupérer les données, depuis une application comme Excel ou par un appel dans du code PHP ou Python par exemple.

La donnée d'usage devient donc à son tour un fournisseur de données en interne ou en externe selon les besoins et les configurations.

Vous devez tout d'abord accéder aux données d'usage. Voir Comment accéder aux données d'usage ?

Il faut ensuite rechercher votre donnée d'usage, voir Comment rechercher une donnée d'usage ?

L’icône  en dessous du nom de la donnée d'usage permet d’exporter les données de la donnée d’usage par appel à un API rest.

Cette fonctionnalité n’est disponible que si l’option REST API est activée dans les options d’édition de la donnée d’usage :

Dans ce cas, un menu de configuration de l’appel à l’API REST nous permet de la paramétrer.

Vous pouvez donner un nom et enregistrer le paramétrage de votre API avec les boutons Nouveau et Enregistrer en haut à droite pour créer des templates d'appels API.

Il est possible de limiter le nombre de lignes exportées avec le champ Lignes, par défaut toutes les lignes sont renvoyées.
Vous pouvez sélectionner les colonnes que vous souhaitez exporter en cliquant en dessous de Colonnes, la liste des colonnes de la DU s’affiche alors et vous pouvez décocher celles que vous ne souhaitez pas exporter.
Si vous voulez filtrer les données des différentes colonnes vous pouvez le faire dans la zone Filtrer.
Il faut ensuite sélectionner le format d’export souhaité dans la liste Type d’export parmi les valeurs suivantes : JSON, CSV, XLS, XLSX, QVX.
Une fois le paramétrage terminé, il faut cliquer sur le bouton Rafraichir afin de générer l’URL sous Liens.

Enfin, pour récupérer les données, il suffit simplement d'utiliser le lien afficher.

Attention :

• L'utilisateur doit avoir les droits de consultation sur la donnée d'usage pour utiliser l'API
• Il est nécessaire de s'authentifier au portail Suadeo pour récupérer les données d'une API notamment par un système de bearer token (cf. https://suadeo2766.zendesk.com/hc/fr/articles/15825370480657)
• Le lien de récupération des données restera toujours le même, même en cas de mise à jour de la donnée d'usage, afin de faciliter la récupération des données depuis des applications ou utilisateurs clients