API Rest - Automate_Evolve - Automate_Studio_Manager - 20.3

Guide d'utilisation d'Automate Evolve

Product type
Logiciels
Portfolio
Integrate
Product family
Automate
Product
Automate > Automate Evolve
Version
20.3
Language
Français
Product name
Automate Evolve
Title
Guide d'utilisation d'Automate Evolve
Topic type
Administration
Référence
Aperçu
First publish date
2018

Les API Rest permettent l'intégration de Composer Solution avec d'autres systèmes à l'aide d'une API HTTP REST (c'est-à-dire le protocole HTTP pour accéder aux données, qui s'appelle normalement API REST). Seules les API REST qui prennent en charge le type de contenu JSON (c'est-à-dire les API avec un en-tête type de contenu vers application / json et Accepter vers application / json) sont prises en charge. Tout autre type de contenu comme xml, binaire, x-www-form-urlencoded etc. n'est pas pris en charge.

L'auteur de Composer sera en mesure de créer une nouvelle connexion de données de type API REST et comme toute autre connexion de données, cette connexion de données peut être créée dans la portée Solution ou dans la bibliothèque de connexion dans la portée Application, ou dans la portée Globale. La connexion aux données de l'API REST peut également être utilisée avec d'autres fonctions comme le contrôle des requêtes, le contrôle des consultations, le contrôle des services Web, le résolveur de participants, etc.

Remarque : La licence n'exige pas d'utiliser des API REST. Elle peut être utilisée simplement en créant une connexion de données de type "API Rest".

Authentification

Les informations d'identification pour une connexion API peuvent être ajoutées soit lors de la création de la connexion de données API, c'est-à-dire en activant la case à cocher Activer les informations d'identification système, soit en accédant à Informations d'identification de la source de données.

  • Activer les informations d'identification système : activez ce bouton basculant pour utiliser les informations d'identification, pour l'authentification. De même, si des informations d'identification de niveau utilisateur sont ajoutées aux informations d'identification du système, les informations d'identification du système sont prioritaires par rapport aux informations d'identification du niveau utilisateur. S'il est activé, l'utilisateur doit entrer des informations d'identification lors de la création de la connexion de source de données sur cette page. (le nom d'utilisateur et le mot de passe sont affichés) S'il est désactivé, l'utilisateur doit entrer ses informations d'identification sur la page Informations d'identification de la source de données (le nom d'utilisateur et le mot de passe sont masqués).

  • Informations d'identification au niveau utilisateur : akouté au niveau de l'utilisateur en accédant à l'angle supérieur droit d'Evolve et en cliquant sur le nom de l'utilisateur, puis en sélectionnant Informations d'identification de source de données. L'utilisateur pourra ajouter des informations d'identification pour la connexion Rest API dont le type d'authentification est De base, De base Sap Hana ou Salesforce. La bascule Activer les informations d'identification système est désactivée.

Pour accéder à une API quelconque, le Préfixe de routage sera requis ; il s'agit d'une combinaison de l'URL d'Evolve et de mots-clés spécifiques, par exemple, <Evolve URL>/svr.

Informations d'identification de la source de données

Ajouter

En sélectionnant Ajouter, l'utilisateur doit pouvoir s'identifier pour la connexion aux données Rest API avec le type d'authentification De base, De base Sap Hana ou Salesforce et Activer les informations d'identification système étant désactivé.

Éditer

En sélectionnant Modifier la connexion, l'utilisateur doit pouvoir modifier les informations d'identification à l'aide de l'option Modifier

Supprimer

En sélectionnant la connexion ajoutée, l'utilisateur doit pouvoir supprimer les informations d'identification en utilisant l'option Supprimer.

Les API d'Evolve au format REST, exposéees à utiliser.

Les API ci-dessous sont sécurisées par l'API Gateway et son mécanisme d'authentification pris en charge.

Pour trois options de sécurité sous l'API Gateway, 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”

Nom de l'API  Méthode HTTP Acheminer Description
Données de référence GET

<Route Prefix>/api/v1/ReferenceData?AppName=<AppName>&LibraryName=<LibraryName>&SolutionName=<RefSolutionName>

Cette API permet d'accéder aux données de référence des Solutions de données de référence.

Cette API prend également en charge le filtre OData limité.

Données de solution GET <Route Prefix>/api/v1/SolutionDataSet?AppName=<AppName>&SolutionDataName=<SolutionName>

Cette API permet d'accéder aux données de Solutions.

Cette API prend également en charge le filtre OData limité.

Monitoring (Alertes système) GET <Route Prefix>/api/v1/Monitoring/SystemAlerts/?NotificationId=<Notification Id> Cette API retourne les alertes système d'Evolve, le cas échéant, telles qu'affichées dans la section Alertes système du tableau de bord d'administration.
Monitoring (fermeture des alertes système) POST <Route Prefix>/api/v1/Monitoring/SystemAlerts/Dismiss?NotificationId=<Notification Id> Cette API permet de fermer/supprimer la notification correspondant à un ID de notification donné.