이 페이지는 Cloud Translation API를 통해 번역되었습니다.

거래 기록 정책 구성

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

다음 섹션에 설명된 대로 API 제품 번들의 각 API 제품에 대한 거래 기록 정책을 구성합니다.

소개

거래 기록 정책을 사용하면 수익 창출이 거래 매개변수 및 맞춤 속성을 캡처할 수 있습니다. 수익 창출은 요금제 적용과 같은 수익 창출 처리를 위해 이 정보가 필요합니다.

예를 들어 수익 배분 요금제를 설정하면 수익 창출 API 제품과 관련된 각 거래에서 발생한 수익의 일정 비율이 요청을 실행한 앱의 개발자와 공유됩니다. 수익 배분은 거래의 순 가격 또는 총 가격 (사용자가 지정)을 기준으로 합니다. 즉, 각 거래의 총 가격 또는 순 가격의 비율이 수익 배분을 결정하는 데 사용됩니다. 따라서 수익 창출은 거래의 총 가격 또는 순 가격을 알아야 합니다(해당하는 경우). 거래 기록 정책의 설정에서 총 가격 또는 순 가격을 가져옵니다.

각 트랜잭션에 대해 개발자에게 청구하는 요율표 요금제를 설정하면 트랜잭션에서 전송되는 바이트 수와 같은 커스텀 속성을 기반으로 요금제의 요율을 설정할 수 있습니다. 수익 창출은 맞춤 속성이 무엇이고 어디서 찾을 수 있는지 알아야 합니다. 따라서 거래 기록 정책에 맞춤 속성을 지정해야 합니다.

거래 기록 정책에 거래 속성을 지정하는 것 외에도 거래 성공 기준을 지정하여 거래 성공 시기를 판단할 수 있습니다 (청구 목적). 거래 성공 기준 설정의 예는 거래 기록 정책에서 트랜잭션 성공 기준 설정의 예를 참조하세요. API 제품에 대한 커스텀 속성을 지정할 수도 있습니다 (요금제 요금의 기준이 됨).

트랜잭션 기록 정책 구성

아래에 설명된 대로 제품 번들 페이지에 액세스합니다.

에지

Edge UI를 사용하여 API 제품 번들을 추가할 때 다음 단계를 수행하여 트랜잭션 기록 정책을 구성해야 합니다.

Transaction Recording Policy(거래 기록 정책) 섹션에서 구성할 API 제품을 선택합니다(제품 번들에 API 제품이 여러 개 있는 경우).
거래 속성 구성
맞춤 속성 구성하기
리소스를 고유한 거래 ID로 연결합니다.
환불 구성
API 제품 번들에 정의된 각 API 제품에 대해 위 작업을 반복합니다.

Classic Edge (Private Cloud)

기존 Edge UI를 사용하여 거래 기록 정책을 구성하려면 다음 안내를 따르세요.

http://ms-ip:9000에 로그인합니다. 여기서 ms-ip는 관리 서버 노드의 IP 주소 또는 DNS 이름입니다.
상단의 탐색 메뉴에서 게시 > 제품을 선택합니다.
해당 API 제품 행에서 + 트랜잭션 기록 정책을 클릭합니다. 새 거래 녹음 정책 창이 표시됩니다.
다음 단계를 따라 거래 기록 정책을 구성합니다.
저장을 클릭합니다.

트랜잭션 속성 구성

거래 속성 섹션에서 수익 창출 거래의 성공 여부를 나타내는 기준을 지정합니다.

Transaction Success Criteria(거래 성공 기준) 필드에서 거래 성공 시점(청구 목적)을 판단하기 위해 상태 속성(다음에서 설명) 값을 기준으로 표현식을 지정합니다. 성공하지 못한 거래(즉, 표현식의 기준을 충족하지 않는 거래)는 기록되지만 요금제가 적용되지 않습니다. 예를 들면 다음과 같습니다.
txProviderStatus == 'OK'

txProviderStatus은 수익 창출에서 거래의 성공을 결정하는 데 사용하는 내부 변수입니다. 트랜잭션 성공 기준을 설정하는 예시는 트랜잭션 기록 정책에서 트랜잭션 성공 기준 설정의 예를 참고하세요.

Status(상태) 속성에는 Transaction Success Criteria(트랜잭션 성공 기준) 필드에 구성된 표현식에서 사용하는 값이 포함됩니다. 다음 필드를 정의하여 상태 속성을 구성합니다.

필드	설명
API 리소스	수익 창출 거래를 식별하는 데 사용될 API 제품에 정의된 URI 패턴입니다. 수익 창출 관련 참고사항: 거래 기록 정책을 정의하는 데 사용되는 API 제품 리소스 경로의 경우 `/`를 명시적으로 사용하세요. 수익 창출은 `/`을 `/`가 아닌 기본 경로 전용으로 취급합니다. API 제품 관리를 참조하세요.
응답 위치	속성이 지정된 응답의 위치입니다. 유효한 값은 흐름 변수, 헤더, JSON 본문, XML 본문입니다.
값	응답 값입니다. 값을 두 개 이상 지정하려면 + x 추가 (예: + 흐름 변수 추가)를 클릭합니다.

선택적 트랜잭션 속성을 구성하려면 Use Optional Attributes 전환을 사용 설정하고 다음 표에 정의된 트랜잭션 속성을 구성합니다.

속성	설명
총 가격	이 속성은 수익 공유 모델을 사용하는 요금제에만 적용됩니다. 이러한 요금제의 경우 총 가격 또는 순 가격이 필수입니다. 숫자 값이 문자열 유형으로 표현되었는지 확인하세요. 거래의 총가격입니다. 수익 공유 계획의 경우 총 가격 속성 또는 순 가격 속성을 기록해야 합니다. 필요한 속성은 수익 배분에 따라 다릅니다. 예를 들어 거래의 총 가격을 기반으로 하는 수익 배분 요금제를 설정할 수 있습니다. 이 경우 총가격 필드는 필수입니다.
실제 등록금 납부액	이 속성은 수익 공유 모델을 사용하는 요금제에만 적용됩니다. 이러한 요금제의 경우 총 가격 또는 순 가격이 필수입니다. 숫자 값이 문자열 유형으로 표현되었는지 확인하세요. 거래의 순 가격입니다. 수익 공유 계획의 경우 순 가격 필드 또는 총 가격 필드를 기록해야 합니다. 필수 필드는 수익 배분에 따라 다릅니다. 예를 들어 거래의 순 가격을 기준으로 하는 수익 배분 요금제를 설정할 수 있습니다. 이 경우 순 가격 필드가 필요합니다.
통화	이 속성은 수익 공유 모델을 사용하는 요금제에 필요합니다. 거래에 적용되는 통화 유형입니다.
오류 코드	거래와 관련된 오류 코드입니다. 실패한 트랜잭션에 대한 추가 정보를 제공합니다.
상품 설명	거래에 대한 설명입니다.
세금	이 속성은 수익 공유 모델과 세액이 API 호출에서 캡처되는 경우에만 적용됩니다. 숫자 값이 문자열 유형으로 표현되었는지 확인합니다. 구매에 부과되는 세액입니다. 순 가격과 세금을 더한 가격 = 총 가격

예를 들어 수익 창출은 다음 값을 설정하여 response.reason.phrase 변수의 메시지 응답에서 흐름 변수의 값을 가져옵니다. 값이 괜찮고 수익 창출 한도 확인 정책이 API 프록시 ProxyEndpoint 요청에 연결되어 있으면 수익 창출에서 거래로 집계됩니다.

필드	값
거래 성공 기준	`txProviderStatus == 'OK'`
상태: API 리소스	`**`
상태: 응답 위치	흐름 변수
상태: 흐름 변수	`response.reason.phrase`

커스텀 속성 구성

커스텀 속성 섹션에서 트랜잭션 기록 정책에 포함할 커스텀 속성을 식별합니다. 예를 들어 각 트랜잭션에 대해 개발자에게 청구하는 요율표 요금제를 설정하면 트랜잭션에서 전송되는 바이트 수와 같은 커스텀 속성을 기반으로 요금제의 요율을 설정할 수 있습니다. 그런 다음 이 커스텀 속성을 거래 기록 정책에 포함해야 합니다.

이러한 각 속성은 트랜잭션 로그에 저장되며, 이 로그를 쿼리할 수 있습니다. 또한 요금제를 만들 때도 이러한 속성 중 하나 이상을 선택하여 요금제의 요금을 적용할 수 있습니다.

수익 요약 보고서에 맞춤 거래 속성 포함에 설명된 대로 거래 기록 정책에 정의된 맞춤 속성을 수익 요약 보고서에 포함할 수 있습니다.

커스텀 속성을 구성하려면 Use Custom Attributes 전환을 사용 설정하고 최대 10개의 커스텀 속성을 정의합니다. 거래 기록 정책에 포함하는 각 커스텀 속성에 다음 정보를 지정해야 합니다.

필드	설명
맞춤 속성 이름	맞춤 속성을 설명하는 이름을 입력합니다. 요금제가 맞춤 속성을 기반으로 하는 경우 이 이름이 요금제 세부정보에서 사용자에게 표시됩니다. 예를 들어 맞춤 속성이 기간을 캡처하는 경우 속성의 이름을 지정해야 합니다. 맞춤 속성 요금제를 만들 때 맞춤 속성 (예: 시간, 분, 초)의 실제 단위 값은 평점 단위 필드에 설정됩니다(맞춤 속성 세부정보로 요금제 지정하기 참고).
API 리소스	트랜잭션에서 액세스하는 API 리소스의 URI 접미사 (즉, 기본 경로 뒤의 URI 프래그먼트)를 하나 이상 선택합니다. 사용 가능한 리소스는 거래 속성과 동일합니다.
응답 위치	응답에서 속성이 지정된 위치를 선택합니다. 유효한 값은 흐름 변수, 헤더, JSON 본문, XML 본문입니다.
값	맞춤 속성 값을 지정합니다. 지정하는 각 값은 지정한 위치에서 맞춤 속성을 제공하는 필드, 매개변수 또는 콘텐츠 요소에 해당합니다. 값을 두 개 이상 지정하려면 + x 추가 (예: + 흐름 변수 추가)를 클릭합니다. 예를 들어 콘텐츠 길이라는 맞춤 속성을 구성하고 응답 위치로 헤더를 선택한 경우, 콘텐츠 길이 값이 HTTP 콘텐츠 길이 필드에 제공되면 `Content-Length`을 값으로 지정합니다.

고유한 거래 ID로 리소스 연결

일부 트랜잭션은 단일 리소스에 대한 API 호출을 수반하는 단순합니다. 하지만 다른 트랜잭션은 더 복잡할 수 있습니다. 예를 들어 모바일 게임 앱에서 인앱 상품을 구매하기 위한 트랜잭션에 다음과 같은 여러 리소스 호출이 포함되어 있다고 가정해 보겠습니다.

선불 사용자가 제품을 구매하기에 충분한 크레딧을 보유하고 구매 금액을 할당 ('예약')하도록 하는 예약 API 호출입니다.
선불 사용자의 계정에서 금액을 공제하는 청구 API를 호출합니다.

전체 거래를 처리하려면 수익 창출에서 첫 번째 리소스 (예약 API에 대한 호출과 응답)를 두 번째 리소스 (Charge API에 대한 호출 및 응답)와 연결하는 방법이 필요합니다. 이렇게 하려면 고유한 거래 ID로 리소스 연결 섹션에서 지정한 정보를 사용합니다.

커스텀 속성을 구성하려면 Use Unique Transaction ID 전환 버튼을 사용 설정하고 거래를 연결합니다. 각 트랜잭션에 대해 다른 트랜잭션의 해당 값과 연결되는 리소스, 응답 위치, 속성 값을 지정합니다.

예를 들어 예약 API 호출과 Charge API 호출이 다음과 같이 링크되었다고 가정해 보겠습니다. 예약 API의 응답 헤더에 있는 session_id이라는 필드는 Charge API의 응답 헤더 reference_id에 해당합니다. 이 경우 고유 거래 ID로 리소스 연결 섹션에서 다음과 같이 항목을 설정할 수 있습니다.

리소스	응답 위치	값
`reserve/{id}**`	헤더	`session_id`
`/charge/{id}**`	헤더	`reference_id`

환불 구성

환불 섹션에서 수익 창출이 환불 처리에 사용하는 속성을 지정합니다.

예를 들어 사용자가 수익 창출 API를 사용하는 모바일 앱에서 제품을 구매했다고 가정해 보겠습니다. 거래는 공유된 수익 요금제에 따라 수익이 창출됩니다. 하지만 사용자가 제품에 만족하지 않아 반품을 원한다고 가정해 보겠습니다. 환불을 실행하는 API 호출을 통해 제품이 환불되는 경우 수익 창출은 필요한 수익 창출 조정을 적용합니다. 이 작업은 거래 기록 정책의 환불 섹션에 지정한 정보를 기반으로 이루어집니다.

환불을 구성하려면 Use Refund Attributes 전환을 사용 설정하고 환불 세부정보를 정의합니다.

다음 필드를 정의하여 환불 기준을 정의합니다.

필드	설명
응답 위치	환불 거래에 대한 리소스입니다. API 제품에서 여러 리소스를 제공하는 경우 환불을 수행하는 리소스만 선택할 수 있습니다.
환불 성공 기준	환불 거래의 성공 시점을 판단하기 위해 상태 속성 (다음에서 설명) 값을 기반으로 한 표현식입니다 (청구 목적). 성공하지 못한 (즉, 표현식의 기준을 충족하지 않는) 환불 거래는 기록되지만 요금제가 적용되지 않습니다. 예를 들면 다음과 같습니다. `txProviderStatus == 'OK'`

다음 필드를 정의하여 상태 속성을 구성합니다.

필드	설명
응답 위치	속성이 지정된 응답의 위치입니다. 유효한 값은 흐름 변수, 헤더, JSON 본문, XML 본문입니다.
값	응답 값입니다. 값을 두 개 이상 지정하려면 + x 추가 (예: + 흐름 변수 추가)를 클릭합니다.

다음 필드를 정의하여 상위 ID 속성을 구성합니다.

필드	설명
응답 위치	속성이 지정된 응답의 위치입니다. 유효한 값은 흐름 변수, 헤더, JSON 본문, XML 본문입니다.
값	환불이 처리된 거래의 ID입니다. 예를 들어 사용자가 제품을 구매한 후 환불을 요청하는 경우 상위 거래 ID는 구매 거래의 ID입니다. 값을 두 개 이상 지정하려면 + x 추가 (예: + 흐름 변수 추가)를 클릭합니다.

선택적 환불 속성을 구성하려면 Use Optional Refund Attributes 전환 버튼을 사용 설정하고 속성을 구성합니다. 선택적 환불 속성은 거래 속성 구성에 정의된 선택적 거래 속성과 동일합니다.
참고: 속성 값은 문자열 유형으로 표현되어야 합니다. 그러지 않으면 거래가 집계되지 않을 수 있습니다.

API를 사용하여 거래 기록 정책 관리

다음 섹션에서는 API를 사용하여 거래 기록 정책을 관리하는 방법을 설명합니다.

API를 사용하여 트랜잭션 기록 정책 만들기

거래 기록 정책을 API 제품의 속성으로 지정합니다. 속성 값은 다음을 식별합니다.

트랜잭션 기록 정책이 연결된 제품 리소스의 URI 접미사입니다. 접미사에 중괄호로 묶인 패턴 변수가 포함되어 있습니다. 패턴 변수는 런타임 시 API 서비스에서 평가합니다. 예를 들어 다음 URI 접미사에는 패턴 변수 {id}가 포함됩니다.
```
/reserve/{id}**
```
이 경우 API 서비스는 리소스의 URI 서픽스를 /reserve로 평가하고 그 뒤에 API 제공업체가 정의한 ID로 시작하는 하위 디렉터리를 평가합니다.
연결된 응답의 리소스입니다. API 제품에는 여러 리소스가 있을 수 있으며 각 리소스에는 해당 리소스의 응답에 연결된 트랜잭션 기록 정책이 있을 수 있습니다.
트랜잭션 기록 정책이 캡처할 트랜잭션 매개변수의 응답 메시지에서 콘텐츠를 추출할 수 있는 변수 추출 정책

수익 창출 API가 아닌 관리 API https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id}에 PUT 요청을 실행하여 거래 기록 정책 속성을 API 제품에 추가합니다.

API를 사용하여 거래 성공 기준 지정

트랜잭션 성공 기준을 지정하여 트랜잭션의 성공 여부를 판단할 수 있습니다(청구 목적). 성공하지 못한 거래 (즉, 표현식의 기준을 충족하는 거래)는 기록되지만 요금제가 적용되지 않습니다. 거래 성공 기준을 설정하는 예시는 거래 기록 정책에서 거래 성공 기준 설정의 예를 참조하세요.

거래 성공 기준을 API 제품의 속성으로 지정합니다. 이렇게 하려면 수익 창출 API가 아닌 관리 API https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id}에 PUT 요청을 실행하면 됩니다.

예를 들어 다음 요청에서는 txProviderStatus 값이 success이면 (거래 성공 기준 관련 사양이 강조 표시됨) 거래가 성공한 것입니다.

$ curl -H "Content-Type: application/json" -X PUT -d \ 
'{
        "apiResources": [
        "/reserve/{id}**"       
        ],
        "approvalType": "auto",
        "attributes": [                         
        {
                "name": "MINT_TRANSACTION_SUCCESS_CRITERIA",
                "value": "txProviderStatus == 'OK'"
        }
        ],
        "description": "Payment",
        "displayName": "Payment",
        "environments": [
        "dev"
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
        ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

API를 사용하여 커스텀 속성 지정

요금제 요금의 기준이 되는 API 제품에 대한 맞춤 속성을 지정할 수 있습니다. 예를 들어 각 거래에 대해 개발자에게 청구하는 요율표 요금제를 설정하면 트랜잭션에서 전송되는 바이트 수와 같은 커스텀 속성을 기반으로 요금제의 요율을 설정할 수 있습니다. 요금제를 만들 때 요금제의 요율에 기반할 커스텀 속성을 하나 이상 지정할 수 있습니다. 하지만 요금제에 포함된 특정 제품에는 요금제 요율의 기반이 되는 맞춤 속성이 하나만 있을 수 있습니다.

커스텀 속성은 API 제품의 속성으로 지정합니다. 수익 창출 API가 아닌 관리 API https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id}에 PUT 요청을 실행하면 됩니다.

API 제품에 추가하는 각 맞춤 속성에 대해 이름과 속성 값을 지정해야 합니다. 이름은 MINT_CUSTOM_ATTRIBUTE_{num} 형식이어야 하며 여기서 {num}은 정수입니다.

예를 들어 다음 요청은 세 개의 커스텀 속성을 지정합니다.

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
        "apiResources": [
        "/reserve/{id}**",
        "/charge/{id}**"
        ],
        "approvalType": "auto",
        "attributes": [
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_1",
                "value": "test1"
        },
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_2",
                "value": "test2"
        }
 
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
                ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

트랜잭션 기록 정책에서 트랜잭션 성공 기준을 설정하는 예

다음 표에서는 트랜잭션 성공 기준 표현식 및 API 프록시에서 반환한 txProviderStatus 값을 기준으로 성공적인 트랜잭션과 실패한 트랜잭션의 예시를 제공합니다. txProviderStatus은 수익 창출에서 거래 성공을 결정하는 데 사용하는 내부 변수입니다.

성공 기준 표현식	올바른 표현식인가요?	API 프록시의 txProviderStatus 값	평가 결과
`null`	true	`"200"`	false
`""`	false	`"200"`	false
`" "`	false	`"200"`	false
`"sdfsdfsdf"`	false	`"200"`	false
`"txProviderStatus =='100'"`	true	`"200"`	false
`"txProviderStatus =='200'"`	true	`"200"`	true
`"true"`	true	`"200"`	true
`"txProviderStatus=='OK' OR txProviderStatus=='Not Found' OR txProviderStatus=='Bad Request'"`	true	`"OK"`	true
`"txProviderStatus matches '(OK)\|(Not Found)\|(Bad Request)'"`	true	`"OK"`	true
`"txProviderStatus matches '(OK)\|(Not Found)\|(Bad Request)'"`	true	`"Not Found"`	true
`"txProviderStatus matches '(OK)\|(Not Found)\|(Bad Request)'"`	true	`"Bad Request"`	true
`"(txProviderStatus?:'') matches '(?i)(OK)\|(Not Found)\|(Bad Request)'"`	true	`"Bad Request"`	true
`"(txProviderStatus?:'') matches '(?i)(OK)\|(Not Found)\|(Bad Request)'"`	true	`null`	false
`"txProviderStatus matches '(?i)(OK)\|(Not Found)\|(Bad Request)'"`	true	`"bad request"`	true
`"txProviderStatus matches '(?i)(OK)\|(Not Found)\|(Bad Request)'"`	true	`"Redirect"`	false
`"txProviderStatus matches '(?i)(OK)\|(Not Found)\|(Bad Request)'"`	true	`"heeeelllooo"`	false
`"txProviderStatus matches '(?i)(OK)\|(Not Found)\|(Bad Request)'"`	true	`null`	false
`"txProviderStatus == 100"`	true	`"200"`	false