1. Home
  2. Iterop Design
  3. Configurer les services
  4. Utiliser l’API V2 (version bêta)

Utiliser l’API V2 (version bêta)

Un certain nombre de fonctionnalités d’Iterop est accessible via une nouvelle version API REST pour une intégration efficace avec vos outils. Cette interface possède plusieurs nouveaux avantages comme un mécanisme de sécurité plus avancé et personnalisable.

Important

L’API V2 est encore en bêta, de nouvelles fonctionnalités seront ajoutées au fur est à mesure de son développement.

Information

Vous retrouverez l’interface de l’API V2 dans l’onglet « administration » de votre instance.

Accéder à l’API V2 avec un accès service / robot

Pour vous connecter à l’api V2 avec un accès services ou robot, il faut préalablement configurer un accès.

Créer un accès

L’API V2 permet une gestion beaucoup plus poussée des autorisations, pour chaque accès il est possible de choisir exactement quelle sont les requêtes qui seront disponibles ou les méthodes (GET..). Pour créer un accès API V2, vous devez :

  • Cliquez sur Créer un compte API v2
  • Nommez le compte 1️⃣
  • Autorisez ou non l’authentification par HTTP basic 2️⃣
  • Sélectionnez les verbes HTTP que vous voulez autoriser 3️⃣
  • Définissez le scope autorisé 4️⃣
    • identity/groups/XXX autorise toutes les méthodes identity/groups/XXX
    • identity/groups/* autorise toutes les méthodes identity/groups/XXX
    • identity/groups/** autorise toutes les méthodes identity/groups/XXX/XXX
  • Ajoutez ou non un autre scope 5️⃣
Information

Pour accéder à la documentation technique interne à votre instance cliquez sur « Cliquez ici pour accéder à la documentation » ou rendez-vous sur https://nomdevotreInstance.iterop.cloud/api-docs/v2/index.html

Utiliser les accès de connexion

L’API v2 possède une interface de service en ligne, mais il est préférable de passer par un client REST tel que Postman ou Insomnia, ou par un service REST directement dans Iterop.

Toutes les requêtes ont besoin d’un jeton d’identification (Token) pour vous identifier. Nous allons voir ici comment le récupérer.

Il faut utiliser requête : GET Jwt token.

Information

Cette requête est disponible à tous, il n’est donc pas nécessaire de la prévoir dans les scopes.

Voici son path :

POST : https://monInstance/api/v2/auth

Voici le Body :

BODY :
{
"accessKey": "ITBMK0V92ZY9QQU93D7OJ6OA",
"secret": "LYrqcshbyxixX93rxZUibzqisd1MhMMMVRjWDz7DvyFbmUSwfJkvri"
}
  • un Token JWT
    • Ce jeton est valable pendant 30 minutes. Il doit ensuite être actualisé ou généré à nouveau.

Utiliser son compte Iterop

Il est aussi possible de se connecter grâce à des identifiants Iterop. Dans ce cas, les accès à toutes les méthodes et ressources correspondront aux droits du compte sur l’application. Les rôles autorisés (utilisateur, designer, administrateur) sont énumérés dans la documentation de chaque méthode.

Toutes les requêtes auront là aussi besoin d’un jeton d’identification (Token) pour vous identifier.

La méthode pour le récupérer est la même que pour les accès service, mais AccessKey fait maintenant office de login et secret de mots de passe.

Pour rappel voici son path :

POST : https://monInstance/api/v2/auth

Et voici un exemple de Body :

BODY :
{
"accessKey" : "john.doe",
"secret" : "azerty",
"human" : true
}

Le retour de cette méthode est :

  • un Token JWT
    • Ce jeton est valable pendant 30 minutes. Il doit ensuite être actualisé ou généré à nouveau.
  • un refresh Token
    • Ce jeton peut être utilisé pour obtenir un nouveau jeton d’accès sans avoir à refournir les identifiants permettant ainsi de prolonger l’accès aux services.
Updated on 13 octobre 2021

Was this article helpful?

Related Articles