Configurar y probar la integración HTTP genérica para las APIs HTTP de SAP

Requisitos previos

• Servidor de integración desplegado y registrado en la plataforma que pueda conectarse a la API HTTP de SAP

• Datos de SAP disponibles mediante llamadas HTTP estándar

• Acceso a Asset Settings en RealityPlatform

• Documento OpenAPI que describa la API HTTP (v2.0, v3.0 o v3.1)

  • El documento puede ser YAML o JSON

  • El documento puede almacenarse localmente dentro de la carpeta Assets del servidor de integración, o puede ser una URI de S3

Pasos de configuración

Esta guía describe cómo configurar la integración HTTP genérica para recuperar datos en un RealityAsset.

Los pasos principales para configurar la integración HTTP son los siguientes:

1. Registrar la fuente de datos HTTP en RealityPlatform

2. Vincular la integración a un tipo de activo

3. Enviar una consulta de prueba para validar la conexión con la API

Consideraciones especiales para sistemas sin conectores directos

Aunque esta guía usa SAP como ejemplo de referencia, el mismo enfoque se aplica a cualquier sistema que no tenga un conector directo pero que pueda exponer sus datos a través de HTTP.

En tales casos, es una práctica común usar un envoltorio HTTP (o pasarela de API) que expone los datos del sistema a través de llamadas HTTP estándar. Muchas plataformas empresariales —incluidos los productos SAP— ofrecen capacidades integradas o complementarias para esto, pero se puede usar cualquier solución equivalente.

Requisitos de la integración:

• Debe admitirse la autenticación basada en tokens.

• Se prefieren las solicitudes GET para recuperar datos, aunque en el futuro se admitirán otros verbos HTTP y métodos de autenticación.

• Se requiere un documento OpenAPI (versión 2.0, 3.0 o 3.1) que describa la API

Registrar la fuente de datos HTTP en el servidor de integración

• Añade la nueva fuente de datos

• Selecciona el tipo HTTP

• Rellena los parámetros requeridos para establecer la conexión

Parámetros de la fuente de datos 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

La URL base de la fuente de datos HTTP.

allowInsecure

Permite que el servidor de integración consulte servidores web con certificados no válidos o autofirmados.

schemaFile

El archivo de esquema que describe la API HTTP.

authBearerToken (Opcional)

El token bearer para la autenticación, si corresponde.

authBasic (Opcional)

La información de autenticación básica, si corresponde.

customAuthenticationHeader (Opcional)

Un encabezado de autenticación personalizado como un registro de pares clave-valor, si corresponde.

Nota

• La especificación OpenAPI se puede poner a disposición dentro del servicio de integración y la ruta debe estar en el parámetro de configuración “schemaFile”. La forma más sencilla de lograrlo es almacenar el archivo en el sistema de archivos interno del servicio de integración y simplemente proporcionar la ruta relativa en la configuración.

• También es posible almacenar la especificación OpenAPI dentro de AWS S3 y proporcionar la URI de S3 al servidor de integración. Debes asegurarte de que el servidor de integración pueda leer el documento desde AWS S3.

Vincular las propiedades del tipo de activo con HTTP

Antes de vincular, asegúrate de tener:

• Un tipo de activo existente con una propiedad para contener los valores de parámetro HTTP requeridos (por ejemplo, Asset ID). Debe ser un tipo de propiedad “Short text”.

• Un servidor de integración configurado con una fuente de datos y consultas HTTP.

Para vincular una propiedad del tipo de activo a HTTP:

1. En Asset Settings → Asset Types, abre el tipo de activo que quieres vincular.

2. En el panel Integration Links (lado derecho), haz clic en Create Integration Link.

   

3. Introduce un nombre de enlace y selecciona el servidor de integración configurado para AWS IOT SiteWise.

4. Elige la fuente de datos apropiada

5. Elige la consulta deseada

6. Para cada parámetro requerido (por ejemplo, id), selecciona la propiedad del tipo de activo que debe proporcionar su valor (por ejemplo, Id).

   

7. Haz clic en Save para crear el enlace.

Cuando este tipo de activo se asigna a los activos, los valores de las propiedades vinculadas se pasarán automáticamente a través de HTTP al ejecutar la integración.

Enviar una consulta de prueba para validar la conectividad entre RealityPlatform y la fuente de datos HTTP

1. En la página de configuración del tipo de activo, haz clic en el botón de reproducción junto al enlace de integración que apunta a la fuente de datos HTTP. Esto abrirá el menú de consulta de prueba.

2. Introduce un parámetro válido en la configuración de parámetros y haz clic en Test query para ver el resultado. Si no se necesitan parámetros para el HTTP, la solicitud se ejecutará automáticamente y se mostrará el resultado.

Nota

• Los valores introducidos aquí son solo para fines de prueba. No se guardan en el tipo de activo ni en los activos vinculados. Esta prueba simula lo que RealityTwin hará cuando se cree un activo, se le asigne este tipo de activo y se rellene la propiedad correspondiente (por ejemplo, id). Usa cualquier parámetro válido para validar la conectividad.