Configurez et testez l'intégration HTTP générique pour les API HTTP de SAP

Prérequis

• Serveur d’intégration déployé et enregistré sur la plateforme pouvant se connecter à l’API HTTP SAP

• Données SAP disponibles via des appels HTTP standards

• Accès aux paramètres d’actifs sur RealityPlatform

• Document OpenAPI qui décrit l’API HTTP (v2.0, v3.0 ou v3.1)

  • Le document peut être YAML ou JSON

  • Le document peut être stocké localement dans le dossier Assets du serveur d’intégration, ou il peut s’agir d’un URI S3

Étapes de configuration

Ce guide expliquera comment configurer l’intégration HTTP générique pour récupérer les données dans un RealityAsset.

Les principales étapes pour configurer l’intégration HTTP sont les suivantes :

1. Enregistrer la source de données HTTP sur RealityPlatform

2. Liez l’intégration à un type d’actif

3. Envoyez une requête de test afin de valider la connexion à l’API

Considérations particulières pour les systèmes sans connecteurs directs

Bien que ce guide utilise SAP comme exemple de référence, la même approche s’applique à tout système qui ne possède pas de connecteur direct mais peut exposer ses données via HTTP.

Dans de tels cas, il est courant d’utiliser un envelopper HTTP (ou une passerelle API) qui expose les données du système via des appels HTTP standards. De nombreuses plateformes d’entreprise — y compris les produits SAP — offrent des fonctionnalités intégrées ou complémentaires pour cela, mais toute solution équivalente peut être utilisée.

Exigences d’intégration :

• L’authentification basée sur un jeton doit être prise en charge.

• Les requêtes GET sont préférées pour récupérer des données, bien que d’autres verbes HTTP et méthodes d’authentification soient pris en charge à l’avenir.

• Un document OpenAPI (version 2.0, 3.0 ou 3.1) qui décrit l’API est requis

Enregistrer la source de données HTTP sur le serveur d’intégration

• Ajouter la nouvelle source de données

• Sélectionnez le HTTP type

• Remplissez les paramètres nécessaires pour établir la connexion

Paramètres de la source de données HTTP

{
  "type": "HTTP",
  "name": "Example HTTP Data Source",
  "baseUrl": "https://example.com",
  "allowInsecure": false,
  "authBearerToken": "exampleBearerToken",
  "authBasic": "exampleBasicAuth",
  "schemaFile": "path/to/openapi/specification",
  "customAuthenticationHeader": {
    "Custom-Header": "HeaderValue"
  }
}

baseUrl

L’URL de base de la source de données HTTP.

allowInsecure

Permettre au serveur d’intégration d’interroger les serveurs web avec des certificats invalides ou auto-signés.

Fichier schema

Le fichier de schéma qui décrit l’API HTTP.

authBearerToken (Optionnel)

Le jeton porteur pour l’authentification, le cas échéant.

authBasic (Optionnel)

Les informations d’authentification de base, le cas échéant.

customAuthenticationHeader (Optionnel)

Un en-tête d’authentification personnalisé comme un enregistrement des paires clé-valeur, le cas échéant.

Note

• La spécification OpenAPI peut être mise à disposition à l’intérieur du service d’intégration et le chemin doit se trouver dans le paramètre de configuration « schemaFile ». La façon la plus simple d’y parvenir est de stocker le fichier dans le système de fichiers interne du Service d’Intégration et de simplement fournir le chemin relatif dans la configuration.

• Il est également possible de stocker la spécification OpenAPI dans AWS S3 et de fournir l’URI S3 au serveur d’intégration. Vous devez vous assurer que le serveur d’intégration peut lire le document depuis AWS S3.

Liaison des propriétés du type d’actif avec HTTP

Avant de mettre le lien, assurez-vous d’avoir :

• Un Type d’Actif existant avec une propriété pour contenir les valeurs requises des paramètres HTTP (par exemple, Asset ID). Il doit s’agir d’une propriété « Texte court ».

• Un serveur d’intégration configuré avec une source de données HTTP et des requêtes.

Pour lier une propriété de type d’actif à HTTP :

1. Dans les paramètres d’actifs → types d’actifs, ouvrez le type d’actif que vous souhaitez lier.

2. Dans le panneau Liens d’intégration (côté droit), cliquez sur Créer lien d’intégration.

   

3. Saisissez un nom de lien et sélectionnez le serveur d’intégration configuré pour AWS IOT SiteWise.

4. Choisissez la source de données appropriée

5. Choisissez la requête souhaitée

6. Pour chaque paramètre requis (par exemple, id), sélectionnez la propriété Type d’Actif qui doit fournir sa valeur (par exemple, Id).

   

7. Cliquez sur Enregistrer pour créer le lien.

Lorsque ce type d’actif est attribué aux actifs, les valeurs des propriétés liées seront automatiquement transmises via HTTP lors de l’exécution de l’intégration.

Envoyez une requête de test pour valider la connectivité entre RealityPlatform et la source de données HTTP

1. Sur la page Paramètres du type d’actif, cliquez sur le bouton lecture à côté du lien d’intégration ciblant la source de données HTTP. Cela ouvrira le menu de requêtes de test.

2. Saisissez un paramètre valide dans la configuration des paramètres et cliquez sur Requête Test pour voir le résultat. Si aucun paramètre n’est nécessaire pour l’HTTP, la requête sera exécutée automatiquement et le résultat sera affiché.

Note

• Les valeurs saisies ici ne sont qu’à des fins de test. Ils ne sont pas enregistrés sur le type d’actif ou les actifs liés. Ce test simule ce que RealityTwin fera lorsqu’un actif est créé, auquel on attribue ce type d’actif, et que la propriété correspondante (par exemple, id) est remplie. Utilisez n’importe quel paramètre valide pour valider la connectivité.