Les API Digital Access permettent l'intégration des systèmes tiers au système de workflow Evolve. Ces API sont sécurisées par l'API Gateway et son mécanisme d'authentification pris en charge.
Conditions requises
Pour tirer parti de l'API Digital Access, voici les conditions préalables :
-
La “Licence Digital Access pour le processus” doit être activée dans le système Evolve.
-
La valeur de la clé “ProcessExtensionEnable” doit être définie sur True.
L'administrateur peut désactiver temporairement cette fonction à partir de Système d'application → Infrastructure → Paramètres avancés. Cette fonction peut être désactivée en supprimant la clé ProcessExtensionEnable et la fonction peut être réactivée en ajoutant la catégorie : "System" et la clé : "valeur ProcessExtensionEnable" définie sur True.
Activation/désactivation de l'API pour une solution Composer
Par défaut, toutes les solutions, c'est-à-dire les solutions Excel et les solutions de formulaire, sont activées pour être accessibles depuis l'API. Ainsi, dès qu'une licence est activée, toutes les solutions existantes seront accessibles à partir de l'API. Une solution peut être explicitement exclue de l'API, ce qui limitera l'accès de cette solution spécifique à l'API ; ce qui signifie qu'un processus ne peut pas être lancé ou qu'une mission ne peut pas être achevée pour les solutions exclues. Pour ce faire, il faut sélectionner la solution et modifier les propriétés de l'API de cette solution à partir de la grille des solutions. Seul l'Administrateur d'application ou le Développeur de solution peuvent voir le bouton des propriétés de l'API et peuvent modifier la valeur pour cette propriété.
Détails d'utilisation d'API pour une solution Composer
L’utilisateur peut vérifier l'utilisation de l'API pour une solution en sélectionnant la solution et en cliquant sur le bouton Utilisation de l'API depuis des options. Pour la Solution Formulaire, l'administrateur d'application peut voir l'utilisation pour Query et pour Transaction. Pour la Solution Excel, l'administrateur d'application peut voir uniquement l'utilisation de Transaction.
Génération de la charge utile
L'utilisateur peut télécharger la charge utile à partir de la grille de solution pour la solution Formulaire et la solution Excel. Pour télécharger la charge utile pour la Solution Formulaire dans le format JSON, cliquez sur le bouton Charge utile JSON et pour télécharger la charge utile au format XML, cliquez sur le bouton Charge utile XML. Pour la Solution Excel, l'utilisateur peut télécharger la charge utile uniquement au format JSON. Pour télécharger la charge utile, sélectionnez la solution dans la grille de solutions et cliquez sur le bouton Charge utile.
- Un formulaire doit être déployé au moins une fois lors du téléchargement de la charge utile XML\JSON pour une solution de formulaire. La charge utile XML\JSON téléchargée sera celle de la dernière version du formulaire déployé.
- La charge utile XML\JSON comprend toutes les valeurs par défaut spécifiées dans le formulaire pour les champs normaux ou répétitifs.
- Utilisez l'API getDocument pour télécharger la charge utile XML\JSON actuelle pour les processus d'exécution : “<EvolveSiteUrl>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Process-Id}/XML" ou “<EvolveSiteUrl>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Process-Id}/JSON"
- L'API mentionnée ci-dessus renverra la charge utile XML\JSON avec des valeurs par défaut ou spécifiées pour le processus d'exécution.
- Lors du téléchargement du contenu JSON, si l'utilisateur est un administrateur global ou un administrateur d'application, le paramètre AppName est ajouté au contenu JSON téléchargé. Si l'utilisateur n'est pas administrateur, il doit ajouter manuellement le paramètre AppName après avoir téléchargé le contenu.
Pour l'URL d'Evolve, l'utilisateur doit spécifier le numéro de port, sauf s'il ne s'agit pas du numéro de port par défaut. Par exemple, si nous disposons d'un site Evolve au port 80 par défaut, nous pouvons utiliser les deux URL Evolve ci-dessous pour accéder à l'API.
-
http://cha-de-vstpnx1.wsdt.local:80/svr/api/v1/Processextn/GetAllAssignments
-
http://cha-de-vstpnx1.wsdt.local/svr/api/v1/Processextn/GetAllAssignments.
Pour trois options de sécurité, les préfixes de routage suivants doivent être utilisés pour accéder à l'API :
Code secret client : “<Evolve URL>/svr”
Jeton de sécurité : “<Evolve URL>/svr”
Certificat : “<Evolve URL>/svrc”
Vous trouverez ci-dessous les différentes API Digital Access :
| Nom de l'API | Méthode HTTP | Acheminer | Description |
|---|---|---|---|
| CompleteAssignment | POST | <RoutePrefix>/api/v1/Processextn/CompleteAssignment | Cette API permet de compléter une affectation ouverte existante. |
| GetAllAssignments | GET | <RoutePrefix>/api/v1/Processextn/GetAllAssignments | Cette API renvoie toutes les affectations ouvertes avec une prise en charge limitée du filtre OData. Elle permet de filtrer les données pour un utilisateur et une solution spécifiques en transmettant le filtre OData dans l'URL d'API. |
| GetDocumentDataByProcess | GET |
<RoutePrefix>/api/v1/Processextn/GetDocumentDataByProcess/<document type>/<processid>/<format> type de document : “Excel” ou “Formulaire" format : “json” ou “xml”. Ne fonctionne que pour un document Formulaire. |
Cette API renvoie la dernière copie du document du processus pour l'ID de processus spécifié. |
| StartExcelProcess | POST |
|
Cette API lance un processus de workflow Excel. Le fichier Excel soumis est soumis à la bibliothèque de solutions respective et un nouveau processus est également lancé sur ce nouveau document. |
| StartFormJsonProcess | POST | <RoutePrefix>/api/v1/Processextn/StartFormJsonProcess | Cette API lance un processus de workflow de formulaire. Les données du formulaire initial doivent être envoyées au format JSON. Il doit s'agir d'un formulaire JSON valide, car aucune validation de données n'est effectuée et aucune règle de champ n'est exécutée lors de l'enregistrement des données de ce formulaire. |
| StartFormProcess | POST |
<RoutePrefix>/api/v1/Processextn/StartFormProcess |
Cette API permet de lancer un processus de workflow de formulaire. Les données du formulaire initial doivent être envoyées au format XML. Il doit s'agir d'un formulaire XML valide car la validation des données ou l'exécution des règles n'est pas effectuée lors de la sauvegarde des données de ce formulaire. |