SAP HTTP API용 일반 HTTP 연동 구성 및 테스트

사전 요구 사항

• SAP HTTP API에 연결할 수 있는, 플랫폼에 배포되고 등록된 Integration Server

• 표준 HTTP 호출을 통해 사용 가능한 SAP 데이터

• RealityPlatform에서 Asset Settings 접근

• HTTP API를 설명하는 OpenAPI 문서(v2.0, v3.0 또는 v3.1)

  • 문서는 YAML 또는 JSON일 수 있습니다

  • 문서는 Integration Server의 Assets 폴더 내에 로컬로 저장하거나 S3 URI일 수 있습니다

구성 단계

이 가이드는 RealityAsset에서 데이터를 검색하기 위해 일반 HTTP 연동을 구성하는 방법을 설명합니다.

HTTP 연동을 구성하기 위한 주요 단계는 다음과 같습니다:

1. RealityPlatform에 HTTP 데이터 소스 등록

2. 연동을 Asset Type에 연결

3. API에 대한 연결을 검증하기 위해 테스트 쿼리 전송

직접 커넥터가 없는 시스템에 대한 특별 고려 사항

이 가이드는 참조 예로 SAP를 사용하지만, 동일한 접근 방식이 직접 커넥터는 없지만 HTTP를 통해 데이터를 노출할 수 있는 모든 시스템에 적용됩니다.

이러한 경우, 표준 HTTP 호출을 통해 시스템의 데이터를 노출하는 HTTP 래퍼(또는 API 게이트웨이)를 사용하는 것이 일반적입니다. SAP 제품을 포함한 많은 엔터프라이즈 플랫폼은 이를 위한 기본 제공 또는 추가 기능을 제공하지만, 동등한 솔루션이면 무엇이든 사용할 수 있습니다.

연동 요구 사항:

• 토큰 기반 인증이 지원되어야 합니다.

• 데이터 검색에는 GET 요청이 선호되지만, 향후 다른 HTTP 동사와 인증 방법도 지원됩니다.

• API를 설명하는 OpenAPI 문서(버전 2.0, 3.0 또는 3.1)가 필요합니다

Integration Server에 HTTP 데이터 소스 등록

• 새 데이터 소스를 추가합니다

• HTTP 유형을 선택합니다

• 연결을 설정하기 위해 필수 매개변수를 입력합니다

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

HTTP 데이터 소스의 기본 URL.

allowInsecure

연동 서버가 유효하지 않거나 자체 서명된 인증서를 가진 웹 서버를 쿼리하도록 허용합니다.

schemaFile

HTTP API를 설명하는 스키마 파일.

authBearerToken(선택 사항)

해당하는 경우, 인증용 bearer token.

authBasic(선택 사항)

해당하는 경우, 기본 인증 정보.

customAuthenticationHeader(선택 사항)

해당하는 경우, 키-값 쌍의 레코드로 된 맞춤 인증 헤더.

참고

• OpenAPI 사양은 연동 서비스 내에서 사용할 수 있게 만들 수 있으며 경로는 “schemaFile” 구성 매개변수에 있어야 합니다. 이를 달성하는 가장 쉬운 방법은 파일을 Integration Service 내부 파일 시스템에 저장하고 구성에 상대 경로를 제공하기만 하면 됩니다.

• OpenAPI 사양을 AWS S3 내에 저장하고 S3 URI를 연동 서버에 제공할 수도 있습니다. 연동 서버가 AWS S3에서 문서를 읽을 수 있는지 확인해야 합니다.

Asset Type 속성을 HTTP에 연결

연결하기 전에, 다음을 갖추었는지 확인하세요:

• 필수 HTTP 매개변수 값(예: Asset ID)을 담을 속성이 있는 기존 Asset Type. 이는 “Short text” 속성 유형이어야 합니다.

• HTTP 데이터 소스와 쿼리로 구성된 Integration Server.

Asset Type 속성을 HTTP에 연결하려면:

1. Asset Settings → Asset Types에서, 연결하려는 Asset Type을 엽니다.

2. Integration Links 패널(오른쪽)에서, Create Integration Link를 클릭합니다.

   

3. 링크 이름을 입력하고 AWS IOT SiteWise용으로 구성된 Integration Server를 선택합니다.

4. 적절한 데이터 소스를 선택합니다

5. 원하는 쿼리를 선택합니다

6. 각 필수 매개변수(예: id)에 대해, 그 값을 제공할 Asset Type 속성(예: Id)을 선택합니다.

   

7. Save를 클릭하여 링크를 만듭니다.

이 Asset Type이 에셋에 할당되면, 연동을 실행할 때 연결된 속성 값이 자동으로 HTTP를 통해 전달됩니다.

RealityPlatform과 HTTP 데이터 소스 간의 연결을 검증하기 위해 테스트 쿼리 전송

1. Asset Type Settings 페이지에서, HTTP 데이터 소스를 대상으로 하는 연동 링크 옆의 재생 버튼을 클릭합니다. 그러면 테스트 쿼리 메뉴가 열립니다.

2. Parameters 구성 아래에 유효한 매개변수를 입력하고 Test query를 클릭하여 결과를 확인합니다. HTTP에 매개변수가 필요하지 않은 경우, 요청이 자동으로 실행되고 결과가 표시됩니다.

참고

• 여기에 입력된 값은 테스트 목적으로만 사용됩니다. Asset Type이나 연결된 에셋에 저장되지 않습니다. 이 테스트는 에셋이 생성되고, 이 Asset Type이 할당되고, 해당 속성(예: id)이 채워질 때 RealityTwin이 수행할 작업을 시뮬레이션합니다. 유효한 매개변수를 사용하여 연결을 검증하세요.