Configurare e testare l'integrazione HTTP generica per le API HTTP di SAP

Prerequisiti

• Server di integrazione distribuito e registrato sulla piattaforma in grado di connettersi all’API HTTP di SAP

• Dati SAP disponibili tramite chiamate HTTP standard

• Accesso alle Impostazioni asset su RealityPlatform

• Documento OpenAPI che descrive l’API HTTP (v2.0, v3.0 o v3.1)

  • Il documento può essere YAML o JSON

  • Il documento può essere archiviato localmente all’interno della cartella Assets del Server di integrazione, oppure può essere un URI S3

Passaggi di configurazione

Questa guida descrive come configurare l’integrazione HTTP generica per recuperare dati in un RealityAsset.

I passaggi principali per configurare l’integrazione HTTP sono i seguenti:

1. Registrare l’origine dati HTTP su RealityPlatform

2. Collegare l’integrazione a un Tipo di asset

3. Inviare una query di prova per verificare la connessione all’API

Considerazioni speciali per i sistemi senza connettori diretti

Sebbene questa guida usi SAP come esempio di riferimento, lo stesso approccio si applica a qualsiasi sistema che non abbia un connettore diretto ma che possa esporre i propri dati tramite HTTP.

In questi casi, è prassi comune usare un wrapper HTTP (o API gateway) che espone i dati del sistema tramite chiamate HTTP standard. Molte piattaforme enterprise — inclusi i prodotti SAP — offrono funzionalità integrate o aggiuntive per questo, ma è possibile usare qualsiasi soluzione equivalente.

Requisiti dell’integrazione:

• L’autenticazione basata su token deve essere supportata.

• Le richieste GET sono preferite per il recupero dei dati, anche se in futuro verranno supportati altri verbi HTTP e metodi di autenticazione.

• È richiesto un documento OpenAPI (versione 2.0, 3.0 o 3.1) che descrive l’API

Registrare l’origine dati HTTP sul Server di integrazione

• Aggiungi la nuova origine dati

• Seleziona il tipo HTTP

• Compila i parametri richiesti per stabilire la connessione

Parametri dell’origine dati 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 di base dell’origine dati HTTP.

allowInsecure

Consente al server di integrazione di interrogare server web con certificati non validi o autofirmati.

schemaFile

Il file di schema che descrive l’API HTTP.

authBearerToken (Opzionale)

Il bearer token per l’autenticazione, se applicabile.

authBasic (Opzionale)

Le informazioni di autenticazione di base, se applicabili.

customAuthenticationHeader (Opzionale)

Un’intestazione di autenticazione personalizzata sotto forma di record di coppie chiave-valore, se applicabile.

Nota

• La specifica OpenAPI può essere resa disponibile all’interno dell’integration service e il percorso dovrebbe essere nel parametro di configurazione “schemaFile”. Il modo più semplice per ottenere questo risultato è archiviare il file nel filesystem interno dell’Integration Service e fornire semplicemente il percorso relativo nella configurazione.

• È anche possibile archiviare la specifica OpenAPI in AWS S3 e fornire l’URI S3 al server di integrazione. Devi assicurarti che il server di integrazione possa leggere il documento da AWS S3.

Collegare le proprietà del Tipo di asset con HTTP

Prima di collegare, assicurati di avere:

• Un Tipo di asset esistente con una proprietà che contenga i valori dei parametri HTTP richiesti (ad es. Asset ID). Deve essere di tipo proprietà “Testo breve”.

• Un Server di integrazione configurato con un’origine dati HTTP e delle query.

Per collegare una proprietà di un Tipo di asset a HTTP:

1. In Impostazioni asset → Tipi di asset, apri il Tipo di asset che vuoi collegare.

2. Nel pannello Collegamenti di integrazione (lato destro), fai clic su Crea collegamento di integrazione.

   

3. Inserisci un nome per il collegamento e seleziona il Server di integrazione configurato per AWS IOT SiteWise.

4. Scegli l’origine dati appropriata

5. Scegli la query desiderata

6. Per ogni parametro richiesto (ad es. id), seleziona la proprietà del Tipo di asset che dovrebbe fornirne il valore (ad es. Id).

   

7. Fai clic su Salva per creare il collegamento.

Quando questo Tipo di asset viene assegnato agli asset, i valori delle proprietà collegate verranno automaticamente passati tramite HTTP durante l’esecuzione dell’integrazione.

Inviare una query di prova per verificare la connettività tra RealityPlatform e l’origine dati HTTP

1. Nella pagina Impostazioni del Tipo di asset, fai clic sul pulsante di riproduzione accanto al collegamento di integrazione che punta all’origine dati HTTP. Questo aprirà il menu della query di prova.

2. Inserisci un parametro valido nella configurazione dei Parametri e fai clic su Test query per vedere il risultato. Se non sono necessari parametri per l’HTTP, la richiesta verrà eseguita automaticamente e il risultato verrà visualizzato.

Nota

• I valori inseriti qui sono solo a scopo di test. Non vengono salvati nel Tipo di asset né negli asset collegati. Questo test simula ciò che farà RealityTwin quando un asset viene creato, gli viene assegnato questo Tipo di asset e la proprietà corrispondente (ad es. id) viene compilata. Usa qualsiasi parametro valido per verificare la connettività.