거래 업체 관리 개체 모델: REST 끝점

업데이트 날짜: 2015년 8월

TPM OM API에 사용되는 REST 끝점입니다.

http://go.microsoft.com/fwlink/p/?LinkId=299821의 단계를 수행하여 BizTalk 서비스를 프로비전하고 나면 환경에 대해 배포 URL이 생성됩니다. 이 URL을 사용하여 TPM OM API에 사용되는 REST 끝점에 도달할 수 있습니다.

항목 내용

TPM OM 엔터티 검색

TPM OM API: 작업 수행 위치

TPM OM API REST 끝점 연결

TPM OM API를 사용하여 .NET 응용 프로그램 만들기

TPM OM API에서는 $metadata 작업을 사용하여 엔터티를 검색할 수 있도록 설정합니다. 메타데이터를 검색할 URI는 다음과 같습니다.

<base_URL>/default/$PartnerManagement/$metadata

여기서 <base_URL>은 BizTalk 서비스 환경의 배포 URL을 나타냅니다. 예를 들어 배포 URL이 https://mybiztalkservice.biztalk.windows.net인 경우 메타데이터를 검색할 URL은 https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/$metadata여야 합니다.

이 URL을 사용하여 모든 유효한 엔터티 유형, 엔터티 속성, 연결 등을 검색할 수 있습니다. 브라우저에서 끝점으로 이동하여 메타데이터를 볼 수도 있습니다.

TPM OM API를 사용하면 기업 간 메시징에 필요한 엔터티를 만들고 관리하는 응용 프로그램을 작성할 수 있습니다. 개체 모델을 사용해도 포털을 통해 제공되는 작업과 완전히 동일한 결과를 얻을 수 있지만 개체 모델 사용과는 별도로 수행되는 몇 가지 작업이 있습니다. 이 섹션에서는 개체 모델, BizTalk 서비스 관리용 PowerShell cmdlet 및 BizTalk Services 포털을 사용하여 각각 수행할 수 있는 작업에 대해 설명합니다.

 

  개체 모델 사용 PowerShell cmdlet 사용 포털 사용

파트너 만들기

--- 프로필 만들기

--- ID 추가

--- 인증서 업로드

X12 규약 만들기

--- Partner1, Partner2 설정

--- ID 추가

--- 스키마 업로드

--- 일괄 처리 만들기

X12 연결 배포

--- 경로 설정 추가

--- 변환 업로드

AS2 규약 만들기

--- Partner1, Partner2 설정

AS2 연결 배포

--- 경로 설정 추가

EDIFACT 규약 만들기

--- Partner1, Partner2 설정

--- ID 추가

--- 스키마 업로드

--- 일괄 처리 만들기

EDIFACT 연결 배포

--- 경로 설정 추가

--- 변환 업로드

TPM OM 엔터티에 대한 메타데이터를 검색하려면 브라우저에서 끝점으로 이동하기만 하면 됩니다. 그러나 엔터티에 대한 CRUD 작업을 수행하려면 요청된 헤더 값과 메시지 페이로드(필요한 경우)가 포함된 메시지를 요청해야 합니다.

  • REST 끝점을 호출하려면 필수 헤더를 포함해야 합니다.

    TPM OM API를 사용하면 OData 기반 HTTP 요청을 보내 TPM OM 엔터티를 만들고 상세 JSON, atom+pub 또는 단순 XML 형식으로 응답을 받을 수 있습니다. TPM OM API는 Azure 디자인 지침을 준수하므로 TPM OM API REST 끝점에 연결할 때 각 클라이언트가 사용해야 하는 필수 HTTP 헤더 집합이 있으며 사용 가능한 옵션 헤더 집합도 있습니다. 다음 섹션에서는 TPM OM API에서 사용할 수 있는 헤더 및 HTTP 동사에 대해 설명합니다.

    필수 및 선택적 헤더 목록은 이 항목의 HTTP 요청, HTTP 응답 및 HTTP 동사 섹션을 참조하세요.

  • 해당되는 경우 적절한 값이 있는 필수 속성 이름을 포함해야 합니다. 엔터티 및 해당 속성 목록은 TPM OM API: 노출된 엔터티 및 속성을 참조하세요.

TPM OM API REST 끝점에 대한 모든 호출에는 필수 헤더 집합을 포함해야 하며 원하는 경우 옵션 헤더 집합도 포함할 수 있습니다. 다음 표에는 필수 헤더가 나와 있습니다.

필수 헤더

 

헤더 Type

권한 부여

WRAP 액세스 제어 토큰

값에는 Microsoft Azure Active Directory 액세스 제어(액세스 제어 서비스 또는 ACS라고도 함)에서 제공하는 액세스 토큰이 포함되어야 합니다. WRAP 프로토콜을 사용하여 액세스 제어 토큰을 검색하려면 http://msdn.microsoft.com/library/windowsazure/hh674475.aspx를 참조하세요.

Host

문자열

대상으로 지정된 리소스의 호스트 및 포트 번호를 지정합니다.

DataServiceVersion

10진수

1.0

MaxDataServiceVersion

10진수

3.0

x-ms-version

10진수

1.0

If-Match

엔터티 태그

요청 헤더에 지정된 엔터티 태그가 개체의 엔터티 태그와 일치하는 경우에만 작업을 수행하도록 지정합니다.

note참고
이 헤더는 업데이트 또는 삭제 작업을 수행할 때만 필요합니다.

note참고
TPM OM API는 OData를 사용하여 REST API를 통해 기본 자산 메타데이터 리포지토리를 표시하므로 모든 요청에는 DataServiceVersionMaxDataServiceVersion 헤더를 포함해야 합니다. 이러한 헤더가 포함되지 않은 경우 현재 TPM OM API는 사용 중인 DataServiceVersion 값이 1.0이라고 가정합니다.

옵션 헤더

 

헤더 Type

날짜

RFC 1123 날짜

요청의 타임스탬프입니다.

Accept

콘텐츠 유형

응답에 대해 요청되는 다음과 같은 콘텐츠 유형입니다.

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml

Accept-Encoding

Gzip, deflate

해당하는 경우 GZIP 및 DEFLATE 인코딩입니다.

Accept-Language

"en", "es" 등

응답의 기본 설정 언어를 지정합니다.

Accept-Charset

UTF-8 등의 문자 집합 유형

기본값은 UTF-8입니다.

X-HTTP-Method

HTTP 메서드

PUT 또는 DELETE와 같은 HTTP 메서드를 지원하지 않는 메서드나 클라이언트가 GET 호출을 통해 터널링된 이러한 메서드를 사용할 수 있도록 합니다.

콘텐츠-유형

콘텐츠 유형

POST 및 PUT 요청의 요청 본문 콘텐츠 유형입니다.

아래에는 요청한 리소스 및 수행하려는 작업에 따라 반환될 수 있는 헤더 집합이 나와 있습니다.

 

헤더 Type

날짜

RFC 1123 날짜

요청이 처리된 날짜입니다.

콘텐츠-유형

상황에 따라 다름

응답 본문의 콘텐츠 형식입니다.

Content-Encoding

상황에 따라 다름

Gzip 또는 deflate 중 적절한 항목입니다.

Cache-Control

-

서버에서 클라이언트로의 캐싱 메커니즘이 개체를 캐시할 수 있는지 여부를 지정합니다.

Content-Length

콘텐츠 유형

응답 본문의 길이입니다.

서버

-

서버 이름입니다.

X-Content-Type-Options

콘텐츠 유형

사용 가능한 값은 "nonsniff"뿐이며, 이 값은 브라우저가 선언된 콘텐츠 유형에서 응답을 MIME 스니핑하지 못하도록 지정합니다.

아래에는 TPM OM API에서 지원하며 HTTP 요청을 수행할 때 사용할 수 있는 HTTP 동사의 전체 목록이 나와 있습니다.

 

동사 설명

GET

엔터티의 현재 값을 반환합니다.

POST

제공된 데이터를 기준으로 개체를 만들거나 명령을 제출합니다.

PUT

개체를 바꾸거나 해당하는 경우 새 개체를 만듭니다.

DELETE

개체를 삭제합니다.

MERGE

명명된 속성 변경 내용으로 기존 개체를 업데이트합니다.

TPM OM API는 OData 프로토콜을 기반으로 하기 때문에 WCF Data Services를 사용하여 엔터티에 대한 CRUD 작업을 수행하는 .NET 응용 프로그램을 빌드할 수 있습니다. TPM OM API를 사용하여 .NET 응용 프로그램을 만드는 방법에 대한 자세한 내용은 TPM OM REST API를 사용하여 .NET 응용 프로그램 만들기를 참조하세요.

참고 항목

표시: