Les workflows et les clés API ne sont pas disponibles dans la solution Essentials.
Informations importantes
Ce guide s’adresse à ceux qui souhaitent intégrer des applications tierces à leur portail CoreView. Ceci peut être pertinent si vous voulez déclencher un workflow en réponse à des événements spécifiques tels que :
- Le service RH soumet un nouveau formulaire après l’embauche d’un nouvel employé ;
- La création d’un nouveau ticket dans un système de gestion des incidents.
Cependant, si votre portail CoreView est exclusivement géré par des administrateurs tenant humains et des opérateurs, vous pouvez ignorer entièrement cette section.
L’objectif de cet article est de fournir à nos clients les informations nécessaires concernant les exigences, prérequis et le processus étape par étape pour intégrer avec succès des applications tierces à votre tenant CoreView via l’API CoreView.
Les destinataires visés pour cet article et l’exécution des activités décrites sont les membres du personnel technique senior de votre organisation en charge des services d’entreprise.
Il est essentiel que les personnes appropriées dans votre organisation examinent les informations fournies ici et contactent CoreView pour toute question avant de planifier un déploiement.
Vue d’ensemble
Les instructions ci-dessous expliquent comment l’API CoreView peut être utilisée pour exécuter vos workflows CoreView. Actuellement, l’API CoreView est simple d’utilisation et prend en charge l’interaction avec les workflows. Cela signifie que les seules actions que vous pouvez gérer via l’API publique sont :
- Obtenir les exécutions de workflows
- Obtenir l’historique d’exécution des workflows
- Démarrer des exécutions manuelles
- Lister les workflows
- Obtenir les détails d’un workflow
- Obtenir un jeton JWT
Avant d’utiliser l’API, vous devez déployer au moins un workflow dans votre portail CoreView ; sinon, aucune méthode de l’API ne pourra être utilisée pour interagir avec CoreView.
PostMan
L’intégration API permet aux clients d’invoquer tout workflow CoreView à partir de plateformes externes capables d’appeler des URLs et d’y passer des valeurs.
Dans ce guide, nous utiliserons PostMan comme logiciel simulant l’appel API vers le data center CoreView. Vous pouvez télécharger la dernière version de PostMan ici.
PostMan est une plateforme API gratuite permettant de construire et d’utiliser des APIs. Elle simplifie chaque étape du cycle de vie de l’API et facilite la collaboration, ce qui vous permet de comprendre plus rapidement comment manipuler les APIs.
Comme première étape, veuillez importer le fichier “CoreFlow Public API.postman_collection.json” dans votre tableau de bord PostMan. Ceci affichera toutes les méthodes que vous pouvez appeler.
Pour importer le fichier JSON, suivez ces étapes :
- Ouvrez PostMan et créez un compte.
- Cliquez sur l’icône en haut à droite.
- Sélectionnez : “Fichier” > “Importer”.
- Cliquez sur “Importer un fichier existant”.
- Sélectionnez le fichier “CoreFlow Public API.postman_collection.json” que vous avez enregistré sur votre ordinateur.
Détails de l’API CoreView
Vous êtes maintenant prêt à appeler les méthodes de l’API CoreView. Avant toute requête, vous devez gérer l’authentification.
L’authentification est gérée via une clé API, qui est nécessaire pour générer un jeton “bearer” à utiliser dans chaque appel de méthode.
Pour obtenir votre jeton bearer, cliquez sur “Get JWT API” et renseignez l’URL suivante : https://www.loginportal.online/api/auth
Générer votre clé API
Vous devez remplacer la clé API dans la section En-têtes (“Headers”) par votre propre clé API, générée dans votre portail CoreView :
Étape 1
Connectez-vous à votre portail CoreView avec les droits administrateur, ouvrez le menu déroulant “PARAMÈTRES” puis sélectionnez “Clés API”.
Étape 2
Pour ajouter une nouvelle clé API, cliquez sur le bouton “Ajouter une nouvelle clé API”.
Dès que vous créez la clé API, assurez-vous de la copier, car elle ne sera plus visible par la suite.
Méthode 1 : Obtenir un jeton JWT
Retournez sur PostMan, sélectionnez “En-têtes”, et collez la clé API que vous venez de copier dans le champ “Authorization” :
Après avoir cliqué sur “Envoyer”, vous recevrez un jeton bearer dans la section “Body” du résultat, que vous utiliserez pour tout autre appel de méthode API.
Veuillez noter que les jetons expirent sous 48 heures (environ 2 jours) ; il est donc recommandé de générer un jeton bearer pour chaque requête.
Si vous souhaitez vérifier les détails du jeton bearer, copiez la valeur du jeton sur le site jwt.io pour afficher toutes les informations qui s’y rapportent.
La date d’expiration apparaît dans le champ “exp”. Survolez la valeur “exp” avec la souris pour voir la date d’expiration du jeton :
ID
Méthode 2 : Lister les workflows
Cliquez maintenant sur l’élément “List Workflows” et remplacez la valeur d’autorisation par le jeton bearer que vous venez de générer :
Notez que pour appeler toute méthode API, vous avez aussi besoin de la valeur “X-scompany ID”. Veuillez contacter votre consultant CoreView pour obtenir la valeur X-scompany ID attribuée à votre tenant CoreView.
Méthode 3 : Démarrer une exécution manuelle
Voyons maintenant comment démarrer un workflow en utilisant la méthode “Start Manual Execution”. Pour exécuter un workflow, vous devez modifier l’URL pour pointer vers le bon data center CoreView.
Consultez le tableau ci-dessous pour identifier les URLs appropriées à utiliser :
| URLs API V2 | |
|---|---|
| Authentification GOV US | https://uslogin.coreview.com/api/auth |
| Authentification (tous autres DC) | https://www.loginportal.online/api/auth |
| Europe | https://coreflowapi.coreview.com |
| Canada | https://coreflowcaeapi.coreview.com |
| Est des États-Unis | https://coreflowusapi.coreview.com |
| Gov US | https://coreflowusgovapi.coreview.com |
| Australie | https://coreflowausapi.coreview.com |
Retrouvez toutes les étapes du processus ci-dessous :
Étape 1
Après avoir obtenu l’URL du data center, renseignez-la dans la section "POST" de la méthode "Start Manual Executions".
Étape 2
Vous trouverez l’ID du workflow dans la liste obtenue précédemment lors de l’appel à l’API "Get Workflow Details". Vous pouvez également retrouver cette information dans la réponse JSON de l’API "List Workflows" que vous venez d’exécuter.
Étape 3
Renseignez maintenant l’URL avec l’ID du workflow que vous souhaitez exécuter.
Étape 4
Renseignez le jeton bearer et l’ID de la société dans la section en-têtes de votre workflow.
Étape 5
Si votre workflow attend des variables d’entrée, il suffit de cliquer sur le workflow à exécuter dans le portail CoreView, puis de vérifier les variables en cliquant sur “Modifier le workflow” puis sur “Configurer les entrées d’exécution”.
Étape 6
Cliquez ensuite sur la section “Body” de votre fenêtre PostMan et renseignez les propriétés en fonction des variables d’entrée que vous venez de vérifier.
Méthode 4 : Obtenir les exécutions de workflow
Cette méthode permet d’obtenir les modes d’exécution de votre workflow, par exemple pour vérifier si un workflow particulier est en cours d’exécution.
Il suffit de copier l’ID de votre workflow et de le coller dans la commande “GET” de l’API “Get Workflow Executions”.
Retrouvez toutes les étapes du processus ci-dessous :
Étape 1
Vous pouvez interroger un workflow à la fois en définissant le filtre sur “En cours d’exécution”.
Étape 2
N’oubliez pas de renseigner l’ID société et le jeton bearer dans la section “En-têtes”.
Étape 3
Une fois terminé, cliquez sur le bouton “Envoyer” et vous récupérerez le workflow en cours d’exécution à ce moment précis.
Méthode 5 : Obtenir l’historique d’exécution d’un workflow
Il s’agit de la dernière méthode API disponible. Elle vous permet d’obtenir les détails d’un workflow exécuté, similaires à ceux que vous pouvez consulter dans l’historique d’exécution du workflow dans le portail CoreView.
Retrouvez toutes les étapes du processus ci-dessous :
Étape 1
Indiquez l’URL pour appeler l’ID de workflow et l’ID d’exécution que vous venez d’obtenir via “Get Workflow Execution”.
Étape 2
L’ID du workflow est le même que celui que vous avez exécuté.
Étape 3
Copiez l’ID d’exécution à partir de la réponse JSON que vous avez reçue lors de l’exécution de “Get Workflow Executions”.
Étape 4
N’oubliez pas de renseigner le jeton d’autorisation bearer et l’ID de la société dans la section “En-têtes” de votre requête.
Étape 5
Après avoir cliqué sur le bouton bleu “Envoyer” dans la fenêtre PostMan, vous trouverez tous les détails concernant le workflow que vous venez d’exécuter. Vous pouvez utiliser ce JSON pour tout besoin spécifique.
