Tester l’API

Logo HandleData HandleData - Version 8.6.0

Pour tester l’API

  • Vous devez posséder le droit "Modification" sur l’Exposition API

  • L’API doit être publiée (Statut "Disponible" ou "Indisponible")

Le test d’une API publiée par Data Producteur permet de simuler un appel vers l’API tel qu’il peut-être réalisé par les consommateurs. Le résultat (colonnes, données) affichées correspondent exactement à celles que voit un consommateur.

En résumé

  • Le test de l’API s’effectue sur l’API publiée (qu’elle soit Disponible ou Indisponible) à partir de la configuration publiée, elle n’affecte pas les données l’API

    • Si vous venez de créer un accès ou d’ajouter un consommateur dans les paramètres de publication et que vous n’avez pas publié ces modifications, il ne sera pas possible de le tester

  • Pour voir les résultats de l’API, vous devez définir le type de simulation que vous souhaitez effectuer

    • pour un utilisateur unique référencé comme consommateur

    • pour un ou plusieurs groupes référencés comme consommateurs

    • pour un ou plusieurs accès

  • Différents paramètres permettent de construire et tester une requête précise

  • L’URL peut être affichée au format REST ou OData

  • Les résultats peuvent être affichés au format tabulaire, JSON ou XML (OData uniquement)

Généralités

La simulation d’une requête API pour un utilisateur, des groupes ou des accès permet de vérifier que les paramètres d’accès d’une API publiée sont correctement configurés.

Le résultat (colonnes disponibles et données) tient compte de l’ensemble des paramètres du ou des accès publiés qui sont concernés par le test (colonnes visibles, filtres sur ligne, hachage, etc …​).

Pour tester l’API, cliquer sur Tester l’API depuis la page de détail d’une Exposition API.

Simuler un appel API

En tant que Data Producteur, vous pouvez tester l’API en simulant l’appel pour un autre utilisateur (ou un groupe d’utilisateur).
Vous pouvez aussi voir le résultat du paramétrage d’un accès spécifique ou du cumul de plusieurs accès.

Il est possible de simuler l’appel API * pour un utilisateur spécifique, entré comme consommateur dans un ou plusieurs accès * pour un ou plusieurs groupes entrés en tant que consommateurs * pour un accès spécifique ou un ensemble d’accès

Vous ne pouvez voir que les utilisateurs ajoutés en tant que consommateur : si vous n’avez ajouté que des groupes, vous ne pourrez pas tester l’API en tant qu’utilisateur.
Pour consulter les résultats attendus pour la simulation vous devez

  1. Choisir du type de simulation : Utilisateur Groupe(s) Accès

  2. Sélectionner l’utilisateur, le(s) groupe(s) ou le(s) accès à tester

  3. Clic sur Simuler : Les colonnes ainsi que les paramètres de requête disponibles s’affichent

L’accès ouvert ne peut être sélectionné que seul comme accès à tester.

Vous pouvez afficher les résultats attendus (lignes), en cliquant sur Tester à côté de l’URL affichée ou modifier la requête à l’aide du formulaire de paramétrage de requête.

Modifier les paramètres de la requête

Plusieurs champs permettent de personnaliser la requête et de construire une URL spécifique (que vous pouvez partager directement avec les consommateurs)

  • Colonne(s) : colonnes à inclure dans la requête

    • Si aucune colonne n’est sélectionnée, toutes les colonnes sont incluses (correspond à un all)

    • L’ordre des colonnes peut-être modifié en glissant-déposant chaque étiquette de colonne vers la gauche ou la droite

  • Filtre sur ligne : ensemble de règles qui permettent d’affiner le résultat en filtrant les lignes

    • Le filtre doit respecter la syntaxe pour être valide

  • Colonne(s) de tri : défini l’ordre de tri des colonnes

    • Le sens du tri peut être modifié en cliquant sur la flèche de l’étiquette

    • L’ordre du tri peut être modifié en glissant-déposant chaque colonne vers la gauche ou la droite

  • Page : défini la page à afficher

  • Nombre de lignes par page : fixe un nombre maximum de lignes par page à remonter dans la requête

L’URL est mise à jour au fur et à mesure que vous modifiez les paramètres de la requête.
Pour afficher les résultats à partir des nouveaux paramètres, cliquer sur Tester.

Résultats de la requête

Les résultats peuvent être affichés sous différents formats : tableau, JSON et XML (pour OData uniquement).

Dans le cas où la requête est erronée, un message d’erreur affiche le détail du problème rencontré.

Les données visibles correspondent au résultat attendu pour le type de simulation en cours.
Les données sont identiques à celles envoyées directement par l’API.

Les paramètres des accès liés à la simulation en cours impactent directement les résultats

  • Colonnes : seules les colonnes non masquées et accessibles pour le(s) consommateur(s), groupe(s) ou accès sélectionné(s) sont visibles

  • Lignes : seules les lignes correspondant aux filtres définis dans les accès sont visibles (par exemple, uniquement les lignes où la colonne "IsActive" est "TRUE"). Si une colonne est paramétrée comme "hachée", les données visibles seront hachées

Dans le cas où plusieurs paramètres d’accès s’appliquent (par exemple un utilisateur fait partie de 2 groupes eux même dans 2 accès différents), seules les colonnes actives dans les 2 accès seront visibles (synthèse restrictive).
Les lignes visibles correspondent au cumul de l’ensemble des filtres (synthèse additive).