Api : identification (format de données json)
L’utilisation de l’API nécessite de s’authentifier avec les identifiants de votre compte DMC, envoyés par mail à l’administrateur du service.
Pour faire ce test nous allons utiliser notre outil API WorkShop.
Dans la page qui s’affiche, renseignez les champs repérés par une pastille rouge :
- Saisissez votre numéro de service DMC.
- Saisissez votre mot de passe API (fournis à l’administrateur).
- Saisir votre espace DMC.
- Dérouler le bloc « Administration ».
- Dérouler la méthode « finduser ».
- Cliquer sur le bouton « tester » (aucun paramètre obligatoire pour cette méthode).
Dans la fenêtre de la méthode vous avez
- La base de l’url qui appelle la méthode : doit être précédée de https://www.dmc.sfr-sh.fr/DmcWS
- La variable « Authenticate » en mode GET
- Le résultat de la requête (ici tous est OK, la liste des utilisateurs est retournée)
Le champ « success » à true (indique que la requête c’est bien exécutée.)
Le champ « response » qui contient le tableau de la liste des utilisateurs (si pas du d’utilisateurs sur votre espace alors liste vide [].
En cas d’erreur
Si une erreur se produit, le résultat de la requête doit ressembler à l’image ci-dessous :
Le résultat de la requete vous indique l’erreur:
Le champ « success » est à false.
Le champ « errorCode » vous indique le code de l’erreur (ici identification incorrecte)
Le champ « errorDetail » vous indique le message en français.
Le champ « fatal » vous indique que c’est une erreur fatale.
Le champ « invalidParams » à true indique que c’est un problème de paramètre.
Dans le cas ci-dessous, c’est l’id de l’espace qui est incorrecte
