vsa:zoom_sur_l_api

Veryswing propose une API (Application Programming Interface) qui vous permettra d’échanger des données avec d’autres applications. Nous vous proposons un ensemble de méthode qui vous permettrons cet interfaçage. Il sera à votre charge de développer les différents connecteurs nécessaires entre vos logiciels et nos applications.

L'API est développée sur les standard REST (Representational State Transfer) et est donc utilisable par tous les outils qui peuvent envoyer des requêtes sous format JSON à une architecture REST.

Pour utiliser l'API il faut utiliser un compte utilisateur API spécifique.

IMPORTANT : Pour les méthodes d’insertion de données, il est impératif que le compte utilisateur API soit lié à un compteur utilisateur présent dans VSA/VSP

Aller dans Administration > Utilisateurs API Si vous ne voyez pas cet écran, il faudra vous ajouter le droit dans votre groupe de sécurité.

Cet écran vous donne de la visibilité sur tous les profils utilisateurs API créés.

Pour plus d’information sur la création d’un utilisateur API, cliquez ici

En plus de ce compte utilisateur, il faudra dans chacune de vos requêtes, préciser un token (jeton) de sécurité.

A NOTER : Ce token est unique et n'est valable que pendant 24h.

Comment récupérer un token ? Le token se récupéré via la documentation VS API. (Voir ci-dessous comment accéder à la documentation.) Aller dans Authentication

Cliquez sur POST /login Get your auth token Puis cliquez sur Try it out en haut à droite du formulaire

Compléter le Request body par le login et le mot de passe du compte API, puis cliquez sur Exécute

Vous trouverez ensuite votre token comme ci-dessous

Votre token est : eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJleHAiOjE1OTEyNzMwNTIsImFwaV91c2VyX2lkIjoiMiIsImxvZ2luIjoiZ3VpbGxhdW1lIn0.Xnk5LpsOhYiLheudxFdx7mcxyUACNWM095AP14KJORRcUbuDO7wvtVwOhqeLw8I8Z5A7bI5RZutjy6fBN-iMBA Remontez ensuite tout en haut de l’écran et cliquez sur Authorize

Copier le token dans la partie Value du formulaire qui s'ouvre puis Authorize et enfin Close

Nous vous proposons 4 types de méthode pour gérer le flux de données.

Comment accéder aux méthodes disponibles ? Toutes les méthodes de l’API sont disponibles dans la documentation de l’API. Pour y accéder vous devez vous connecter à l’URL suivante : https://lien_de_votre_application/api/doc Nous utilisons Swagger (V3) pour générer ces documentations. Swagger est une documentation interactive qui permet de rapidement tester l'API

Les détails d’une méthode Zoom sur les réponses

1. Cliquer sur la méthode GET - /v1/recruitment/candidate, puis sur Try It out 2. Cliquez sur Exécute

3. Dans la partie “Responses”, vous trouverez le détail des résultats 4. Si vous développez une interface liée à cette méthode d'API, vous pourrez utiliser les données JSON sortante pour par exemple afficher la liste de vos candidats dans un autre outil

  • vsa/zoom_sur_l_api.txt
  • Dernière modification: 17/06/2020 14:20
  • de Caroline BABRON