L'API SAP Data est exposée pour télécharger des données vers et depuis SAP. Cette API est disponible pour Evolve et Studio Manager. Cette solution est régie par un workflow Script avec des paramètres de workflow de script. L'API expose la charge utile JSON et d'autres détails (comme les paramètres d'exécution de SAP, etc.) pour publier des données sur SAP.
Pour accéder à l'API SAP Data depuis Evolve, exécutez les étapes suivantes :
- Activez une licence d'API SAP Data valide.
- Créer une bibliothèque de stockage de l'API SAP.
- Créez un script dans Studio à utiliser lors de l'ajout de l'API SAP depuis Evolve. Reportez-vous à Créer un script pour l'intégration à l'API SAP Data dans l'API SAP Data avec Studio.
- Ajoutez l'API SAP depuis l'onglet Solutions.
Bibliothèque de stockage de l'API SAP
Pour l'enregistrement des solutions des API SAP Data sur Evolve, l'utilisateur doit créer une nouvelle bibliothèque depuis Evolve. Vous trouverez ci-dessous les étapes de création d'une nouvelle bibliothèque :
-
Accédez à Evolve → Configuration → Gérer les bibliothèques, dans l'application dans laquelle la bibliothèque doit être créée.
-
Cliquez sur Ajouter.
-
Le type à sélectionner doit être SAPAPIStore.
-
Spécifiez le Nom et la Description de la blbliothèque. Ces deux champs sont obligatoires.
-
Activez l'option Activer l'historique du document si vous souhaitez générer des documents pour la solution d'API SAP lors de l'exécution. La valeur par défaut sera false.
-
Cliquez sur Enregistrer.
-
Accédez à la page Solutions et la nouvelle bibliothèque doit être visible avec toutes les autres bibliothèques.
Lorsque la clé SapIntegrationAPIEnable est activée, le type de bibliothèque SAPAPIStore sera également activée pour toutes les applications Evolve. Cette bibliothèque ne sera pas disponible pour les applications de référence de données. Le type de bibliothèque SAPAPIStore sera activé sous Ajouter une bibliothèque. Seuls les Administrateurs d'application et les Administrateurs globaux sont autorisés à ajouter cette bibliothèque.
Pour gérer les autorisations de bibliothèque de type “SAPAPIStore”, accédez à Configuration → Gérer les bibliothèques depuis Evolve et sélectionnez les API SAP Data en cliquant sur la case à cocher présente sur la grille de la table. Cliquez sur Gérer les autorisations de bibliothèque. Comme la bibliothèque de formulaire, la bibliothèque SAPAPIStore présente également deux options de gestion des autorisations, les Autorisations de processus et les Autorisations de solution de bibliothèque pour gérer les autorisations de bibliothèque SAPAPIStore. L'autorisation par défaut des autorisations de processus est définie sur Créateur ; l'utilisateur peut supprimer l'autorisation par défaut et ajouter des autorisations d'un groupe de créateurs quelconque. L'autorisation par défaut de l'autorisation de solution de bibliothèque est définie sur Développeur de solution et Réviseur de solution ; l'utilisateur peut supprimer les autorisations par défaut et ajouter un groupe quelconque d'autorisations de Développeur de solution et de Réviseur de solution.
Les Paramètres d'approbation d'API SAP peuvent être ajoutés sur la page Application → Préférences → Préférences de conception, avec les trois options suivantes. La valeur par défaut est false pour les trois options.
-
Approbation de solution : si cette option est définie sur True, la solution soumise à Evolve sera en phase de révision jusqu'à ce que le Réviseur l'approuve depuis les tâches.
-
Auto-approbation : si cette option est définie sur True, la solution soumise par le résultat peut approuver lui-même la solution et le nom de l'utilisateur s'affichera dans la liste Réviseurs lors de la soumission ou la mise à jour de l'API SAP Data.
-
Raison du rejet de script : si cette option est définie sur True, l'utilisateur doit définir une raison pour réjeter la solution.
Ajoutez l'API SAP depuis l'onglet Solutions
Une fois la bibliothèque SAPAPIStore sélectionnée dans Solutions, l'option Ajouter une API devient disponible. Cette option n'est visible que si l'utilisateur connecté a un rôle de Développeur de solution. L'utilisateur autorisé peut cliquer sur Ajouter une API pour générer un schéma d'API Web à l'aide de scripts pour charger/télécharger les données depuis SAP vers le schéma JSON.
L'option Ajouter une API affiche un assistant en trois étapes qui sont : Informations d'API, Sélectionner les fichiers et Sélectionner un réviseur.
Informations d'API comporte les champs suivants :
-
Nom : nom du service/de la solution ; il doit être unique au niveau bibliothèque.
-
Catégorie : facilite la classification des solutions dans différentes catégories qu'il est possible de filtrer ultérieurement sur la page solutions. La catégorie n'est pas un champ obligatoire.
-
Description : peut être utilisé par l'utilisateur pour expliquer ce qu'est la solution. La description n'est pas un champ obligatoire.
L'API Creation propose deux options Créer à partir de Transaction et Créer à partir de Query ; l'option par défaut est Créer à partir de Transaction. L'API Creation comporte les champs suivants :
-
Sélectionner un fichier : seul un script JSON mappé sera pris en charge pour générer le schéma d'API. Si le script est de type Query, les niveaux d'utilisation du système (Faible, Moyen et Elevé) seront affichés.
-
Visionneuses : il existe deux visionneuses JSON Zone de texte et Visionneuse JSON ; la sélection par défaut est Visionneuse JSON. Les deux visionneuses ont une largeur et une hauteur fixes et activent la barre de défilement en fonction du texte JSON.
Vous devez créer un script dans Studio, à utiliser dans Evolve. Reportez-vous à Créer un script pour l'intégration à l'API SAP Data dans l'API SAP Data avec Studio.
Après avoir sélectionné un fichier de script valide à l'aide de Sélectionner un fichier, l'appel de méthode de service génère les spécifications de l'API et l'affiche sur la visionneuse JSON. JSON présente trois onglets InputPayload, OutputPayload et ErrorPayload. Les spécifications de l'API pour InputPayload et OutputPayload correspondent au fichier de script et ErrorPayload est un tableau fixe. Le type de données correspondant au type de données du script et aux spécifications de l'API sera disponible dans les charges utiles générées.
Les options InputPayload et OutputPayload proposent les sections suivantes :
-
RunParameter : il a tous les champs d'entrée pour Transaction. Le script Query affiche tous les champs de critère définis par l'utilisateur et ignore les champs de critères fixes.
-
SolutionDetail : il comporte les champs SolutionName, LibraryName et AppName.
-
RequestParameter : il comporte toutes les entrées d'exécution, par exemple, le nombre d'enregistrements, GetRecordCount, etc.
-
SAPDetails : il comporte les champs obligatoires ConnectionName et EvolveUser. Les autres champs comme SAPUser, SAPCredentials et Windows Credentials sont des champs facultatifs.
Sélectionner un réviseur sera affiché si l'indicateur Approbation de solution sous Paramètres d'approbation d'API SAP est défini sur true. Il existe une liste déroulante Vérificateurs qui montre tous les utilisateurs qui ont le rôle de vérificateur de solution dans l'application en cours. Si le paramètre Auto-approbation a la valeur false, l'utilisateur actuellement connecté n'est pas visible dans la liste déroulante, même si l'utilisateur en cours a le rôle de vérificateur de solution dans l'application. La solution ne peut pas être soumise sans la sélection d'un vérificateur.
Une fois la solution soumise, elle s'affichera sur la page Solution dans les colonnes Solution, Description, Statut, Catégorie, Révisé par et Créé par.
L'URL des API SAP Data seront <RoutePrefix>/api/v1/SAPIS
Si l'indicateur Approbation de solution sous les paramètres d'approbation de l'API SAP est défini sur true, la solution doit être soumise à l'aide d'un réviseur. Une fois la solution soumise, la tâche est affectée à un réviseur pour révision. Si la préférence Raison du rejet de solution est activée, le réviseur de solution doit spécifier les raisons du rejet. Si le workflow solution est appliqué, Mettre à jour l'API ne fonctionnera que si la solution est à l'état Production.
Mettez à jour l'API SAP depuis l'onglet Solutions
L’utilisateur peut utiliser Mettre à jour l'API pour la solution qui est à l'état Production. Dans les Paramètres d'approbation d'API SAP (App→ Préférences→ Page Préférences de conception), si l'approbation de solution est activée, la solution sera en révision jusqu'à ce que le réviseur affecté l'approuve. Il est impossible de mettre à jour les solutions en Révision. Après avoir approuvé la solution et l'avoir mise en production, l'utilisateur peut mettre à jour la solution de l'API SAP Data. Si la révision de solution est désactivée, la solution sera toujours en production et l'utilisateur peut alors modifier la solution de l'API SAP. Vous trouverez ci-dessous les détails pour mettre à jour l'API :
-
Accédez à Solutions et sélectionnez la bibliothèque de l'API SAP Data.
-
Sélectionnez la solution de l'API SAP (en Production) que vous souhaitez mettre à jour en cliquant sur la case à cocher sur la grille de solution.
-
Cliquez sur Mettre à jour l'API.
-
Le nom de service/solution est en lecture seule uniquement. Les champs Catégorie et Description sont modifiables.
-
Le type de script sera sélectionné en fonction du type de script existant et les autres options seront désactivées. Le champ Sélectionner un fichier sera autorisé pour ajouter le même type de script.
-
L'URL du service et les vues JSON (Zone de texte et visionneuse JSON ) sont en lecture seule uniquement.
-
Ces étapes s'afficheront si l'indicateur Approbation de solution sous Paramètres d'approbation d'API SAP est true. La liste déroulante Vérificateur affiche tous les utilisateurs qui ont un rôle Vérificateur de solution dans l'application actuelle. Si le vérificateur de solution actuel est disponible dans la liste des vérificateurs, le même vérificateur est sélectionné.
-
Si le paramètre Auto-approbation a la valeur false, l'utilisateur actuellement connecté ne doit pas se trouver dans la liste déroulante, même si l'utilisateur en cours a le rôle de vérificateur de solution dans l'application. La solution ne peut pas être soumise sans la sélection d'un vérificateur.
-
Cette action va créer une nouvelle version de la solution.
Afficher l'API SAP
Pour afficher l'API SAP, cliquez sur l'option Afficher l'API après avoir sélectionné une solution particulière dans la bibliothèque de l'API SAP. L'intégralité des données sera affichée sur une seule page, en tant que Vue de la référence de schéma. JSON peut être affiché dans les deux visionneuses JSON, c'est-à-dire Zone de texte et Visionneuse JSON.
L'URL du service sera affiché sous la forme <BaseURL/GatewayURL>/api/v1/SAPIS.
Exécution de l'API SAP Data
Pour exécuter l'API Intégration, l'utilisateur doit renseigner l'en-tête d'authentification et la charge utile, et l'envoyer au point final valide exposé pour l'exécution. Exécutez les étapes ci-dessous pour exécuter l'API SAP Data :
-
Remplissez tous les champs d'entrée requis de la charge utile comme l'en-tête d'authentification, SolutionName, LibraryName, AppName, ConnectionName, EvolveUser, etc., avant l'exécution.
-
L'utilisateur Evolve doit avoir un rôle de Créateur pour l'exécution de l'API.
-
Pour Transaction - La solution de l'API SAP Data à l'état de production est autorisée à s'exécuter sur le serveur de production. La dernière version de la solution sera applicable. La solution de l'AP SAP Data dans l'état Révisée ou Rejetée est autorisée à s'exécuter sur le système SAP de non-production ; la validation serait exécutée sur les systèmes SAP de production et de non-production.
Pour Query - La solution de l'API SAP Data à l'état de production est autorisée à s'exécuter sur les serveurs de production et de non-production. La dernière version de la solution sera applicable. La solution de l'API SAP à l'état révisée ou rejetée est autorisée à s'exécuter sur un système SAP de non-production.
-
Le champ EvolveUser sera utilisé pour vérifier le rôle et les stratégies et pour vérifier les informations de connexion par rapport à ConnectionName, si les Informations d’identification SAP et les Données d'identification Windows ne sont pas transmises.
Les critères de préférence pour l'exécution de la solution de l'API SAP sont les suivants :
-
Informations d’identification SAP.
-
Données d'identification Windows.
-
Utilisateur Evolve.
La préférence par défaut est d'utiliser EvolveUser pour éviter d'utiliser le mot de passe en texte brut sur le réseau.
-
-
Après l'exécution, le résultat de l'exécution (champs journal et sortie) sera écrasé dans le document JSON.
-
Si l'Historique du document est activé sur la bibliothèque, les documents seront alors uniquement identifiés comme ServiceName_TimeStamp (en chiffres). Le document sera un fichier texte contenant InputPayload et OutputPayload au format JSON. Si l'utilisateur spécifie un mot de passe, alors le mot de passe ne sera pas stocké dans le document. Le document n'a pas de workflow, donc le statut sera toujours Terminé.
Pour afficher l'Utilisation des API, sélectionnez une solution quelconque dans la bibliothèque des solutions et cliquez sur Utilisation des API. La Vue de l'utilisation des API sous forme de colonnes Titre, Fichier de données, Date et heure de l'activité, Système SAP, Enregistrements envoyés et Erreurs d'exécution qui affiche les informations détaillées sur l'exécution des API.
Pour importer/exporter une solution d'API d'intégration, accédez à la solution (c'est-à-dire le test) et téléchargez le script ; vous pouvez maintenant ajouter une nouvelle solution en utilisant le script téléchargé.