De generieke HTTP-integratie voor SAP HTTP-API's configureren en testen

Vereisten

Integratieserver geïmplementeerd en geregistreerd op het platform die verbinding kan maken met de SAP HTTP-API
SAP-gegevens beschikbaar via standaard HTTP-oproepen
Toegang tot Assetinstellingen op RealityPlatform
OpenAPI-document dat de HTTP-API beschrijft (v2.0, v3.0 of v3.1)
- Het document kan YAML of JSON zijn
- Het document kan lokaal worden opgeslagen in de Assets-map van de integratieserver, of het kan een S3-URI zijn

Configuratiestappen

Deze gids beschrijft hoe u de generieke HTTP-integratie configureert om gegevens op te halen in een RealityAsset.

De belangrijkste stappen om de HTTP-integratie te configureren zijn de volgende:

De HTTP-gegevensbron registreren op RealityPlatform
De integratie koppelen aan een assettype
Een testquery verzenden om de verbinding met de API te valideren

Speciale overwegingen voor systemen zonder directe connectors

Hoewel deze gids SAP als referentievoorbeeld gebruikt, geldt dezelfde aanpak voor elk systeem dat geen directe connector heeft maar zijn gegevens via HTTP kan blootstellen.

In dergelijke gevallen is het gebruikelijk om een HTTP-wrapper (of API-gateway) te gebruiken die de gegevens van het systeem via standaard HTTP-oproepen blootstelt. Veel enterprise-platforms — waaronder SAP-producten — bieden hiervoor ingebouwde of add-onmogelijkheden, maar elke gelijkwaardige oplossing kan worden gebruikt.

Integratievereisten:

Tokengebaseerde verificatie moet worden ondersteund.
GET-verzoeken hebben de voorkeur voor het ophalen van gegevens, hoewel andere HTTP-werkwoorden en verificatiemethoden in de toekomst worden ondersteund.
Een OpenAPI-document (versie 2.0, 3.0 of 3.1) dat de API beschrijft, is vereist

De HTTP-gegevensbron registreren op de integratieserver

Voeg de nieuwe gegevensbron toe
Selecteer het type HTTP
Vul de vereiste parameters in om de verbinding tot stand te brengen

Parameters van de HTTP-gegevensbron

{
  "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

De basis-URL van de HTTP-gegevensbron.

allowInsecure

Sta de integratieserver toe om webservers met ongeldige of zelfondertekende certificaten te bevragen.

schemaFile

Het schemabestand dat de HTTP-API beschrijft.

authBearerToken (optioneel)

Het bearer-token voor verificatie, indien van toepassing.

authBasic (optioneel)

De basisverificatie-informatie, indien van toepassing.

customAuthenticationHeader (optioneel)

Een aangepaste verificatieheader als een record van sleutel-waardeparen, indien van toepassing.

Assettype-eigenschappen koppelen aan HTTP

Zorg er vóór het koppelen voor dat u het volgende hebt:

Een bestaand assettype met een eigenschap om de vereiste HTTP-parameterwaarden te bevatten (bijv. Asset ID). Dit moet een eigenschapstype “Korte tekst” zijn.
Een integratieserver die is geconfigureerd met een HTTP-gegevensbron en query’s.

Om een assettype-eigenschap aan HTTP te koppelen:

Open in Assetinstellingen → Assettypen het assettype dat u wilt koppelen.
Klik in het paneel Integratiekoppelingen (rechterkant) op Integratiekoppeling aanmaken.
Voer een koppelingsnaam in en selecteer de integratieserver die voor AWS IOT SiteWise is geconfigureerd.
Kies de juiste gegevensbron
Kies de gewenste query
Selecteer voor elke vereiste parameter (bijv. id) de assettype-eigenschap die de waarde ervan moet leveren (bijv. Id).
Klik op Opslaan om de koppeling aan te maken.

Wanneer dit assettype aan assets wordt toegewezen, worden de gekoppelde eigenschapwaarden automatisch via HTTP doorgegeven bij het uitvoeren van de integratie.

Een testquery verzenden om de connectiviteit tussen RealityPlatform en de HTTP-gegevensbron te valideren

Klik op de pagina Assettype-instellingen op de afspeelknop naast de integratiekoppeling die de HTTP-gegevensbron target. Dit opent het testquerymenu.

Voer een geldige parameter in onder de parameterconfiguratie en klik op Testquery om het resultaat te zien. Als er geen parameters nodig zijn voor de HTTP, wordt het verzoek automatisch uitgevoerd en wordt het resultaat weergegeven.