Zoom sur VS API [Documentation des solutions applicatives éditées par VERYSWING]

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
===== Zoom sur VS 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éthodes qui vous permettront cet interfaçage.
Il sera à votre charge de développer les différents connecteurs nécessaires entre vos logiciels et nos applications.
{{:vsa: interface_api.png?direct|}}
 

==== Généralités ====
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.
{{:vsa: exemple_outils.png?direct|}}
 
==== Connexion et sécurité ====
Pour utiliser l'API il faut utiliser un compte utilisateur API spécifique. 

<color #C71585>IMPORTANT</color> : 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 <color #9E9E9E>Administration > Utilisateurs API</color>
Si vous ne voyez pas cet écran, il faudra vous ajouter le droit dans votre groupe de sécurité. 
{{:vsa: droits_user_API.png?direct|}}

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 [[vsa:utilisateurs_api|ici]]

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

<color #F08080>A NOTER</color>  : Ce token est unique et n'est valable que pendant 24h.
{{:vsa: requete_token.png?direct|}}
 
<color #F08080> Comment récupérer un token ?  </color>
Le token se récupéré via la documentation VS API. (Voir ci-dessous comment accéder à la documentation.)
Aller dans Authentication
{{:vsa: token.png?direct|}}
 
Cliquez sur POST /login Get your auth token
Puis cliquez sur Try it out en haut à droite du formulaire
{{:vsa: token2.png?direct|}}
 
Compléter le Request body par le login et le mot de passe du compte API, puis cliquez sur Exécute
{{:vsa: token3.png?direct|}}

 
Vous trouverez ensuite votre token comme ci-dessous
 
{{:vsa: token4.png?direct|}}

Votre token est : eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJleHAiOjE1OTEyNzMwNTIsImFwaV91c2VyX2lkIjoiMiIsImxvZ2luIjoiZ3VpbGxhdW1lIn0.Xnk5LpsOhYiLheudxFdx7mcxyUACNWM095AP14KJORRcUbuDO7wvtVwOhqeLw8I8Z5A7bI5RZutjy6fBN-iMBA 
Remontez ensuite tout en haut de l’écran et cliquez sur Authorize
{{:vsa: token5.png?direct|}}
 

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

 
==== Les méthodes de VS API ====
Nous vous proposons 4 types de méthode pour gérer le flux de données.
{{:vsa: methodes_api.png?direct|}}

 

<color #F08080> Comment accéder aux méthodes disponibles ?  </color>
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

<color #F08080> Les détails d’une méthode  </color>
{{:vsa: methode_1.png?direct|}}
Zoom sur les réponses 
{{:vsa: methode_2.png?direct|}}

==== Cas pratique – Liste des candidats ==== 
1.	Cliquer sur la méthode GET -  /v1/recruitment/candidate, puis sur Try It out
{{:vsa: methode3.png?direct|}}
2.	Cliquez sur Exécute

{{:vsa: methode4.png?direct|}}

3.	Dans la partie "Responses", vous trouverez le détail des résultats
{{:vsa: methode5.png?direct|}}
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