Un jeton est une clé d'accès aux
API sans exposer de mot de passe et sans passer par un formulaire d'authentification. C'est le moyen le plus sécurisé et pratique pour accéder aux fonctionnalités sans passer par une interface graphique ou de manière automatique : batch,... Un jeton peut être révoqué soit par suppression soit par regénération.
Appel
La clé et le nom d'utilisateur associé doivent être ajoutés dans les paramètres de l'URL d'appel des web services. Le nom de la clé n'est envoyée, puisque l'authentification est basée sur la validation d'une des clés de l'utilisateur.
URL d'origine : GET https://ligoj-server/ligoj/rest/project
URL authentifiée :
GET https://ligoj-server/ligoj/rest/project?api-key=mettre_ici_token&api-user={{$current.$session.userName}}
Mode navigateur
Copier coller l'URL dans la barre de navigation. Ne fonctionne que pour les URL de type GET.
Mode script Windows
Télécharger un client tel que
wget et installer par exemple dans
C:\GnuWin32
.
Exemples (remplacer {TOKEN} par la clé à utiliser) :
-
Liste de projets :
C:\GnuWin32\bin\wget.exe -O "C:\export\project.json" "https://ligoj-server/ligoj/rest/project?api-key={TOKEN}&api-user={{$current.$session.userName}}"
-
SLA d'un projet JIRA (remplacer {ID} par l'identifiant de la souscription) :
C:\GnuWin32\bin\wget.exe -O "C:\export\siop-sla-full.csv" "https://ligoj-server/ligoj/rest/service/bt/jira/export/sla/{ID}/siop-full.csv?api-key={TOKEN}&api-user={{$current.$session.userName}}"
Mode script Unix/Linux
Exemples (remplacer {TOKEN} par la clé à utiliser) :
-
Liste de projets :
wget -O "C:\export\project.json" "https://ligoj-server/ligoj/rest/project?api-key={TOKEN}&api-user={{$current.$session.userName}}"
-
SLA d'un projet JIRA (remplacer {ID} par l'identifiant de la souscription) :
wget -O "C:\export\siop-sla-full.csv" "https://ligoj-server/ligoj/rest/service/bt/jira/export/sla/{ID}/siop-full.csv?api-key={TOKEN}&api-user={{$current.$session.userName}}"