Pour commencer

Afin de pouvoir utiliser les points d'accès décrits dans cette documentation, vous allez en premier lieu devoir générer une clé API.

Vous pourrez créer deux types de clé API :

• Clé API liée à un service

  Cette clé permet l'accès uniquement au service pour lequel elle a été générée.
• Clé API liée à une organisation

  Si vous êtes administrateur d'une organisation, cette clé permet l'accès à tous les services associés à cette organisation.

1. Générer une clé API liée à un service

Comment faire ?

1. Afin de générer une clé API liée à un service, rendez-vous sur Services
2. Cliquez sur le service pour lequel vous souhaitez ouvrir l'accès
3. Dans la page qui s'ouvre, cliquez ensuite sur l'onglet 'Gérer les clés API'.
4. Ensuite cliquer sur 'Générer une clé API'
5. Vous pouvez désormais copier/coller la clé nouvellement créée, vous en aurez besoin pour chacun des points d'accès décrits dans cette documentation.

2. Générer une clé API liée à une organisation

Comment faire ?

1. Afin de générer une clé API liée à une organisation, vous devez être administrateur de cette organisation. Si c'est le cas, rendez-vous sur Organisations
2. Cliquez ensuite sur le bouton 'Clés API', pour l'organisation sur laquelle vous souhaitez ouvrir un accès.
3. Dans la popup qui s'ouvre, vous pouvez ensuite cliquer sur 'Ajouter une clé API'.
4. Vous pouvez désormais copier/coller la clé nouvellement créée, vous en aurez besoin pour chacun des points d'accès décrits dans cette documentation.

3. Point d'accès Infos Démarches

Ce point d'accès retourne les informations sur les services auxquels votre clé donne accès.
Il sera notamment utile pour récupérer les ids des démarches, et ainsi pouvoir filtrer les résultats du point d'accès /statsUsagers.

4. Point d'accès statistiques de satisfaction des usagers

Ce point d'accès retourne les données de satisfaction des utilisateurs pour toutes les démarches liées à la clé fournie.
Il offre les options de filtrage suivantes :

• field_codes : Les codes des questions posées aux utilisateurs. Si vide, retourne les données pour l'ensemble des codes.


Voici la correspondance entre les field_codes et les questions :

• satisfaction : Comment s'est passée cette démarche pour vous ?
• comprehension : Qu'avez-vous pensé des informations et des instructions fournies ?
• contact_tried : Durant votre parcours avez-vous tenté d’obtenir de l’aide par l’un des moyens suivants ?

  (Les sous-questions conditionnelles "contact_reached" et "contact_satisfaction" associées à cette question sont incluses dans le résultat.)
• contact_satisfaction : Comment évaluez-vous la qualité de l'aide que vous avez obtenue de la part de l'administration ?

  (Cette question est une sous-question de "contact_tried" mais l'indiquer dans votre requête permettra d'aggréger les données.)
• contact_reached : Quand vous avez cherché de l'aide avez-vous réussi à joindre l'administration ?

  (Cette question est une sous-question de "contact_tried" mais l'indiquer dans votre requête permettra d'agréger les données.)
• product_ids : Les ids des produits sur lesquels vous souhaitez filtrer les résultats. Si vide, retourne l'ensemble des produits du scope.
• start_date : Date de début (format: yyyy-mm-dd).
• end_date : Date de fin (format: yyyy-mm-dd).
• interval : Définit l'intervalle de temps pour afficher les données ('day', 'week', 'month', 'year'). Indiquez 'none' si vous ne souhaitez pas spécifier d'intervalle.