Konfigurieren und Testen der generischen HTTP-Integration für SAP HTTP APIs

Voraussetzungen

• Integration Server, der auf der Plattform implementiert und registriert ist, die eine Verbindung zur SAP HTTP API herstellen kann

• SAP-Daten, die über Standard-HTTP-Aufrufe verfügbar sind

• Zugriff auf die Asset-Einstellungen auf der RealityPlatform

• JSON-Schemadatei der HTTP-API (optional, aber empfohlen)

Schritte zur Konfiguration

In diesem Leitfaden wird beschrieben, wie Sie die generische HTTP-Integration konfigurieren, um Daten in einem RealityAsset abzurufen.

Die wichtigsten Schritte zur Konfiguration der HTTP-Integration sind die folgenden:

1. Registrieren der HTTP-Datenquelle auf RealityPlatform

2. Verknüpfen Sie die Integration mit einem Asset-Typ

3. Senden einer Testabfrage, um die Verbindung zur API zu validieren

Besondere Aspekte für Systeme ohne direkte Steckverbinder

In diesem Leitfaden wird zwar SAP als Referenzbeispiel verwendet, aber der gleiche Ansatz gilt für jedes System, das nicht über einen direkten Konnektor verfügt, aber seine Daten über HTTP verfügbar machen kann.

In solchen Fällen ist es üblich, einen HTTP-Wrapper (oder API-Gateway) zu verwenden, der die Daten des Systems über standardmäßige HTTP-Aufrufe verfügbar macht. Viele Unternehmensplattformen — einschließlich SAP-Produkte — bieten hierfür integrierte oder Add-on-Funktionen, aber jede gleichwertige Lösung kann verwendet werden.

Anforderungen an die Integration:

• Die tokenbasierte Authentifizierung muss unterstützt werden.

• GET-Anforderungen werden zum Abrufen von Daten bevorzugt, obwohl in Zukunft andere HTTP-Verben und Authentifizierungsmethoden unterstützt werden.

Beste Praxis:
Es wird dringend empfohlen, eine JSON-Schemadatei zu generieren, die die HTTP-API beschreibt.
Dies macht die Integrationskonfiguration einfach, da verfügbare Endpunkte, Datenstrukturen und Feldnamen klar definiert sind.

Registrieren Sie die HTTP-Datenquelle auf dem Integration Server

1. Fügen Sie das Symbol new data source

2. Wählen Sie den HTTP Typ aus

3. Füllen Sie die erforderlichen parameters Felder aus, um die Verbindung herzustellen

Parameter für HTTP-Datenquellen

{
  "type": "HTTP",
  "name": "Example HTTP Data Source",
  "baseUrl": "https://example.com",
  "allowInsecure": false,
  "paths": [
    {
      "name": "examplePath",
      "path": "/api/example",
      "method": "GET",
      "responseCode": 200,
      "requestParameters": [
        {
          "param1": "value1",
          "param2": "value2"
        }
      ],
      "responseSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  ],
  "authBearerToken": "exampleBearerToken",
  "authBasic": "exampleBasicAuth",
  "schemaFile": "exampleSchemaFile",
  "customAuthenticationHeader": {
    "Custom-Header": "HeaderValue"
  }
}

baseUrl

Die Basis-URL der HTTP-Datenquelle.

allowUnsicher

Integrationsserver darf Webserver mit ungültigen oder selbstsignierten Zertifikaten abfragen.

Pfade

Ein Array von Objekten, die Path Pfadinformationen für die Datenquelle enthalten.

Beispiel für einen Anforderungstext

{
  "name": "examplePath",
  "path": "/api/example",
  "method": "GET",
  "responseCode": 200,
  "requestParameters": [
    {
      "param1": "value1",
      "param2": "value2"
    }
  ],
  "responseSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    }
  }
}

authBearerToken (optional)

Das Bearertoken für die Authentifizierung, falls zutreffend.

authBasic (optional)

Die grundlegenden Authentifizierungsinformationen, falls zutreffend.

schemaFile (optional)

Die Schemadatei, die der Datenquelle zugeordnet ist, falls zutreffend.

customAuthenticationHeader (optional)

Ein benutzerdefinierter Authentifizierungsheader als Datensatz von Schlüssel-Wert-Paaren, falls zutreffend.

Hinweis

• Wenn eine Schemadatei verfügbar ist, sollte sie dem Integrationsdienst zur Verfügung gestellt werden, und der Pfad sollte sich im Konfigurationsparameter “schemaFile” befinden. Der einfachste Weg, dies zu erreichen, besteht darin, die Datei im internen Dateisystem des Integrationsdienstes zu speichern und einfach den relativen Pfad in der Konfiguration anzugeben.

• Wenn eine Schemadatei nicht verfügbar ist, ist es möglich, diese im Konfigurationsparameter “Pfade” zu beschreiben.

Warnung

Bitte beachten Sie, dass eine Datenquelle nicht sowohl eine “Pfad”-Beschreibung als auch eine “schemaFile” haben kann.

Verknüpfen von Asset-Typ-Eigenschaften mit HTTP

Stellen Sie vor dem Verknüpfen sicher, dass Sie über Folgendes verfügen:

• Ein vorhandenes Asset Type Element mit einer Eigenschaft, die die erforderlichen HTTP-Parameterwerte enthält (z. B Asset ID. ). Es muss sich um den Eigenschaftstyp “Kurztext” handeln.

• Ein Integrationsserver , der mit einer HTTP-Datenquelle und Abfragen konfiguriert ist.

So verknüpfen Sie eine Asset Type-Eigenschaft mit HTTP:

1. Öffnen Sie unter Asset-Einstellungen → Asset-Typen den Asset-Typ, den Sie verknüpfen möchten.

2. Klicken Sie im Bereich Integrationsverknüpfungen (rechte Seite) auf Integrationsverknüpfung erstellen.

   

3. Geben Sie einen Linknamen ein und wählen Sie den Integrationsserver aus, der für AWS IOT SiteWise konfiguriert ist.

4. Auswählen der geeigneten Datenquelle

5. Wählen Sie die gewünschte Abfrage aus:
   — Abrufen von AWS SiteWise Asset-Attributwerten
   Ruft die Attribute des Assets ab.

   Parameter:

   • Asset-ID

6. Wählen Sie für jeden erforderlichen Parameter (z. B. id) die Eigenschaft Asset-Typ aus, die ihren Wert angeben soll (z. B Id. ).

   

7. Klicken Sie auf Speichern , um den Link zu erstellen.

Wenn dieser Asset-Typ Assets zugewiesen wird, werden die verknüpften Eigenschaftswerte beim Ausführen der Integration automatisch über HTTP übergeben.

Senden einer Testabfrage zum Überprüfen der Konnektivität zwischen RealityPlatform und HTTP-Datenquelle

1. Klicken Sie auf der Seite “Asset-Typ-Einstellungen” auf die Schaltfläche “Wiedergabe” neben dem Integrationslink, der auf die HTTP-Datenquelle abzielt. Dadurch wird das Menü für die Testabfrage geöffnet.

2. Geben Sie unter der Parameterkonfiguration einen gültigen Parameter ein und klicken Sie auf Abfrage testen, um das Ergebnis zu sehen. Wenn keine Parameter für das HTTP benötigt werden, wird die Anfrage automatisch ausgeführt und das Ergebnis angezeigt.

Hinweis

• Die hier eingegebenen Werte dienen nur zu Testzwecken. Sie werden nicht im Asset-Typ oder in verknüpften Assets gespeichert. Dieser Test simuliert, was RealityTwin tun wird, wenn ein Asset erstellt, diesem Asset Type zugewiesen wird und die entsprechende Eigenschaft (z. B. id) ausgefüllt wird. Verwenden Sie einen gültigen Parameter, um die Konnektivität zu überprüfen.