Utilisation d'API pour intégrer les interfaces SAP Entitlement Management (SEM)

Dans SAP Entitlement Management, une API est nécessaire pour faire fonctionner une interface car elle permet la communication et l'échange de données entre SAP Entitlement Management et d'autres systèmes ou applications. Les API définissent et implémentent les interfaces d'entrée et de sortie dans SAP Entitlement Management.

Les interfaces dans SAP Entitlement Management font référence aux mécanismes et protocoles de communication qui facilitent l'échange de données entre la gestion des droits et les systèmes externes.

Les API externes dans SAP Entitlement Management sont nommées ainsi car elles sont conçues pour fournir une interface standardisée pour interagir avec le système de gestion des droits. Ces API servent de passerelle entre le système de gestion des droits et d'autres systèmes externes, permettant l'échange de données et la communication via un ensemble défini d'interfaces de programmation.

Explorons les différents types d'API et d'interfaces qui prennent en charge la gestion des droits.

Dans SAP Entitlement Management, une interface d'entrée est un mécanisme qui permet aux systèmes externes d'envoyer des données et des informations dans l'application SAP. Il peut inclure des informations relatives aux données d'habilitation, aux détails du client, aux informations produit, etc. L'interface d'entrée permet aux systèmes externes de communiquer avec SAP Entitlement Management et de mettre à jour ou synchroniser les données pertinentes dans le système.

Plusieurs API sont disponibles pour définir l'interface d'entrée. Il s'agit notamment des éléments suivants :

• Configurations API
• API de données de base
• API de droit
• API d'utilisation
• API de gestion des utilisateurs (une API est disponible)
• API de mise à disposition (une API est disponible)

Une interface sortante dans SAP Entitlement Management fait référence à un mécanisme qui permet à SAP Entitlement Management d'envoyer des données et des informations aux systèmes externes impliqués dans le processus de réalisation.

Les interfaces de sortie envoient des droits au système de gestion des commandes clients. Plusieurs API sont disponibles pour définir l'interface de sortie. Il s'agit notamment des éléments suivants :

• API de réponse de configuration
• API de réponse et de demande de données de base
• API de réponse aux droits
• API de réponse de consommation
• API de réponse de la gestion des utilisateurs (une API est disponible)
• API de notification d'événement : lorsqu'une action d'événement est définie sur "Envoyer notification", une fois l'événement déclenché, la notification est envoyée via l'API de notification d'événement.
• API d'enregistrements de jobs d'arrière-plan (deux API sont disponibles)
• API de mise à disposition

Les API jouent un rôle crucial dans la facilitation de l'échange de données et de la communication dans les deux sens, ce qui permet une intégration transparente avec les systèmes et partenaires externes.

L'API de génération de droits rationalise le processus en transférant les zones de données pertinentes dans le droit mappé, garantissant ainsi une gestion des droits précise et efficace via un système bien défini et automatisé.

Les données utiles d'une API de génération représentent la valeur du document de vente du système en amont. Cette API déclenche le processus de bout en bout dans SAP Entitlement Management. La valeur de cette API est transférée aux droits mappés via le mappage de l'offre au droit. Chaque droit mappé passe la règle de génération correspondante avec l'ensemble de règles configuré et est utilisé pour créer un droit ou mettre à jour des droits existants dans le système.

Les données utiles d'une API de génération sont configurables. Sélectionnez la vignette Explorer les API et sélectionnez l'ID de génération de droits API v2. Dans la page de configuration, vous pouvez ajouter de nouvelles zones au nœud prédéfini En-tête ou à son nœud inférieur Poste. Vous pouvez également ajouter un sous-nœud sous Postes.

La valeur des zones "Type de document d'en-tête", "Numéro de document d'en-tête" et "Numéro de poste" est transférée dans "Type de document de référence", "Numéro de document de référence" et "Numéro de poste de référence" sur le droit mappé. Si le droit mappé est utilisé pour créer un droit, ces valeurs sont sauvegardées comme "Type de document de préparation", "Numéro de document d'initiation" et "Numéro de poste de préparation" du nouveau droit. Si le droit mappé est utilisé pour mettre à jour un droit existant, les valeurs sont sauvegardées avec le même nom dans l'historique des mises à jour du droit existant.

La valeur des zones "ID d'offre" et "Système d'offre" sera utilisée pour rechercher la configuration "Mappage d'offre à droit" correspondante.

La valeur des zones "ID client", "Système client", "ID d'offre", "Système d'offre" et "Système source" sera directement transmise au droit mappé.

La valeur du "système source" se trouve dans le "système client" ou dans le "système d'offre" géré dans les données de base. Sinon, il doit être géré dans Configuration des données de base du droit Gérer la configuration de base Système source du droit.

La zone "Méthode de génération" est obsolète. Quelle que soit la valeur de cette zone, l'attribut de droit "Méthode de génération" est toujours automatique si le droit est généré via l'API.

La valeur du nœud "Contacts" sous le nœud "Poste" est directement transmise dans le droit mappé en tant que contact affecté au droit. Le système utilise l'ID interne pour rechercher le contact correspondant dans le système. Si "ID interne" est vide, le système utilise "ID externe" plus "Système source" pour rechercher les enregistrements correspondants.

Notez également que le nœud Droit du document de vente sous Poste est utilisé dans le contenu d'intégration standard entre SAP Entitlement Management et SAP Subscription Billing. Il contient une liste des numéros de droit associés au document de vente actuel. Ce nœud peut également être configuré dans un ensemble de règles pour répondre aux besoins du client.

L'API renvoie les informations de contact affectées au droit généré ou mis à jour. Vous pouvez définir une valeur complète pour le paramètre d'en-tête de demande x-ems-contacts.

Pour permettre à l'API de renvoyer uniquement l'ID et la fonction de droit du contact affecté au droit généré ou mis à jour, définissez la valeur de base du paramètre d'en-tête de demande x-ems-contacts. Ce paramètre n'a pas non plus besoin d'être ajouté à l'en-tête de la demande.

La valeur de la zone Fuseau horaire du droit au niveau de l'en-tête est directement transmise dans le droit mappé comme fuseau horaire du droit.

Pour une demande de génération de droit individuelle, le système traite un maximum de 1 000 créations ou mises à jour de droits. Si le nombre de droits créés dépasse 1 000, le système renvoie un message d'erreur.

L'API de génération vous permet de créer des données de base avec un document de vente selon les règles suivantes :

• Un utilisateur peut ajouter des informations sur les données de base d'une commande sous le nœud MasterDataCreation. Les données de base incluent le client, l'offre et le contact.
• Plusieurs enregistrements de données de base peuvent être créés. Cependant, les données de base doivent apparaître dans l'en-tête ou le poste du document de vente ou elles seront ignorées par le système.
• 10 enregistrements de données de base au maximum sont autorisés dans les données utiles lors de l'envoi d'une demande en mode de synchronisation.
• Un maximum de 1000 enregistrements de données de base sont autorisés dans les données utiles lors de l'envoi d'une demande en mode asynchrone.

Si le système détecte des enregistrements sous le nœud MasterDataCreation, il filtre d'abord les enregistrements de données de base qui n'apparaissent pas dans le document de vente et crée les données de base. Cette API ne gère pas la mise à jour des données de base. Si les données de base à créer existent déjà, elles seront ignorées par le système.

De plus, le système ne vérifie pas si la valeur des données de base indiquée est identique à celle d'un enregistrement de données de base existant.

Le processus de création des données de base s'interrompt en cas d'erreur au cours du processus.