Diffusion Multi Canal

api : identification (format de données json)

Tutoriel 27 décembre 2023 3 minutes de lecture

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 :

1. Saisissez votre numéro de service DMC.
2. Saisissez votre mot de passe API (fournis à l’administrateur).
3. Saisir votre espace DMC.
4. Dérouler le bloc « Administration ».
5. Dérouler la méthode « finduser ».
6. Cliquer sur le bouton « tester » (aucun paramètre obligatoire pour cette méthode).

Dans la fenêtre de la méthode vous avez

1. La base de l’url qui appelle la méthode : doit être précédée de https://www.dmc.sfr-sh.fr/DmcWS
2. La variable « Authenticate » en mode GET
3. 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