보고서 관리

현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서로 이동하세요. 정보

소개

수익 창출 보고서를 통해 집중적 사용 정보 및 거래 활동에 액세스할 수 있습니다. 예를 들어 특정 기간 동안 거래 활동이 발생한 애플리케이션, 개발자, API 제품 번들 또는 API 제품을 확인할 수 있습니다. 수익 창출을 사용하면 API 사용량을 추적하는 요약 또는 상세 보고서를 생성할 수 있습니다.

수익 창출 보고서 유형

다음 유형의 수익 창출 보고서를 생성할 수 있습니다.

데이터 보관 정보

Apigee Edge 퍼블릭 클라우드에서 수익 창출 데이터 보관은 요금제 권리입니다. 수익 창출 사용 권한은 https://cloud.google.com/apigee/specsheets에서 확인하세요. 사용 권한 기간이 지난 후에도 수익 창출 데이터를 유지하려면 Apigee 영업팀에 문의하세요. 연장된 데이터 보관은 요청 시 활성화되며 원래 데이터 보관 기간보다 이전인 데이터를 포함하도록 소급하여 활성화할 수 없습니다.

중복 거래 정보

수익 창출 거래 보고서와 애널리틱스 데이터를 비교하면 소수의 중복 거래가 표시될 수 있습니다. 수익 창출 시스템이 매일 수백만 개의 거래를 처리할 수 있고 많은 거래가 특정 시점에 병렬로 처리되므로 이는 예상된 동작입니다. 평균적으로 거래의 약 0.1% 가 중복일 수 있습니다.

수익 창출 보고서 페이지 살펴보기

아래에 설명된 대로 수익 창출 보고서 페이지에 액세스합니다.

보고서 구성하기

다음 섹션에 설명된 대로 UI를 사용하여 보고서를 구성합니다.

보고서 구성 단계

Edge UI 또는 Classice Edge UI를 사용하여 보고서를 구성합니다.

결제 보고서 구성

보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.

선불 잔액 보고서 구성하기

수익 보고서 구성하기

보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.

수익 요약 보고서에 맞춤 거래 속성 포함

거래 기록 정책을 사용하면 거래에서 맞춤 속성 데이터를 캡처할 수 있으며 요약 수익 보고서에 이러한 맞춤 속성을 포함할 수 있습니다. 조직의 MINT.SUMMARY_CUSTOM_ATTRIBUTES 속성을 설정하여 수익 창출 데이터베이스 표에 포함된 기본 커스텀 속성 집합을 정의합니다.

이 기능을 사용하려면 몇 가지 생각과 계획이 필요하므로 아래의 고려사항을 검토하세요.

클라우드 고객이라면 Apigee Edge 지원팀에 문의하여 속성을 설정하세요. 프라이빗 클라우드용 Apigee Edge 고객은 시스템 관리자 사용자 인증 정보를 사용하여 다음 API에 PUT 요청을 사용하여 플래그를 설정합니다.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

이 예시에서 API 호출은 기능을 사용 설정하고 partner_id 및 tax_source 열을 수익 창출 데이터베이스에 추가합니다. API 호출의 커스텀 속성 배열은 URL로 인코딩됩니다.

보고서에 맞춤 거래 속성을 포함할 때의 고려사항

• API로 속성 이름을 만들기 전에 사용할 속성 이름을 확실하게 정하세요. 즉, 데이터베이스의 열 이름이고 맞춤 속성 데이터는 항상 데이터베이스에 저장됩니다.
• 각 트랜잭션 기록 정책에는 다음 이미지와 같이 사용 가능한 맞춤 속성 슬롯이 10개 있습니다. 보고서에 포함될 제품 전체에서 동일한 속성에 대해 정확히 동일한 속성 이름과 위치를 사용합니다. 예를 들어 다음 트랜잭션 기록 정책에서 partner_id 및 tax_source 커스텀 속성은 각각 4번 상자와 5번 상자를 사용합니다. 보고에 포함할 제품에 대한 모든 거래 기록 정책에서 이 고객의 이름과 위치여야 합니다.
  
  

기능을 사용 설정한 후 요약 수익 보고서에 맞춤 속성을 포함하려면 transactionCustomAttributes를 MintCriteria에 추가하여 Report API를 사용합니다. 기준 구성 옵션을 참고하세요.

분산 보고서 구성하기 (지원 중단됨)

보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.

보고서 생성 및 다운로드

보고서를 만든 후 보고서 결과를 CSV 또는 ZIP 파일 형식으로 다운로드할 수 있습니다. CSV 또는 ZIP 파일은 동기식 또는 비동기식으로 생성할 수 있습니다.

• 동기식 보고서의 경우 보고서 요청을 실행하면 분석 서버가 응답을 제공할 때까지 요청이 차단됩니다. 그러나 보고서가 많은 데이터 양(예: 100GB의 데이터)을 처리해야 할 수 있으므로 타임아웃으로 동기식 보고서가 실패할 수 있습니다.

  요약 보고서 수준은 동기 생성만 지원합니다.

• 비동기식 보고서의 경우 보고서 요청을 실행하면 나중에 결과를 검색합니다. 다음은 비동기식 쿼리 처리가 좋은 대안이 될 수 있는 경우입니다.

  • 여러 시간 간격에 걸친 보고서를 분석하고 만드는 경우
  • 쿼리를 복잡하게 만드는 다양한 그룹화 측정기준과 기타 제약조건으로 데이터를 분석하는 경우
  • 일부 사용자 또는 조직에 대한 데이터 볼륨이 현저히 높아진 때 쿼리를 관리하는 경우

  상세 보고서 수준은 비동기 생성을 지원합니다.

CSV 또는 ZIP 파일 형식으로 보고서를 생성하고 다운로드하려면 다음 작업 중 하나를 수행하세요.

1. 보고서 페이지에 액세스합니다.
2. 다운로드할 보고서 위에 커서를 놓습니다.

3. 수정됨 열에서 다음 중 하나를 클릭합니다.

   1. 아이콘 또는 아이콘 (요약 보고서의 경우) 보고서는 동시에 CSV 또는 ZIP 파일로 저장됩니다.
   2. 작업 제출 (상세 보고서용) 비동기 작업이 시작됩니다.

      1. Modified 열에서 작업 상태를 모니터링합니다.

         보고서를 다운로드할 준비가 되면 디스크 아이콘이 나타납니다.

         
      2. 작업이 완료되면 디스크 아이콘을 클릭하여 보고서를 다운로드합니다.

다음은 결제 요약 보고서 CSV 파일의 예입니다.

보고서 수정

보고서를 수정하는 방법은 다음과 같습니다.

1. 보고서 페이지에 액세스합니다.
2. 수정할 보고서 위에 커서를 놓고 작업 메뉴에서 를 클릭합니다.
3. 필요에 따라 보고서 구성을 업데이트합니다.
4. 보고서 업데이트를 클릭하여 업데이트된 보고서 구성을 저장합니다.

보고서 삭제

보고서를 삭제하려면 다음 단계를 따르세요.

1. 보고서 페이지에 액세스합니다.
2. 삭제할 보고서 위에 커서를 놓습니다.
3. 작업 메뉴에서 를 클릭합니다.

API를 사용하여 수익 창출 보고서 관리

다음 섹션에서는 API를 사용하여 수익 창출 보고서를 관리하는 방법을 설명합니다.

API를 사용하여 보고서 구성하기

조직 전체에 대한 보고서를 구성하려면 /organizations/{org_name}/report-definitions에 POST 요청을 실행하세요.

특정 개발자를 위해 보고서를 구성하려면 /organizations/{org_name}/developers/{dev_id}/report-definitions에 POST 요청을 실행합니다. 여기서 {dev_id}는 개발자 ID입니다.

요청할 때 보고서의 이름과 유형을 지정해야 합니다. 유형은 BILLING, REVENUE, VARIANCE (지원 중단됨) 또는 PREPAID_BALANCE 중 하나입니다. 또한 mintCriteria 속성에서 보고서를 추가로 구성하는 기준을 지정할 수 있습니다. 다양한 기준을 지정할 수 있습니다. 이렇게 하면 보고서를 보다 유연하게 구성할 수 있습니다. 기준으로 지정할 수 있는 항목은 다음과 같습니다.

• 결제 또는 선불 잔액 보고서의 경우 보고서의 결제 월
• 수익 보고서의 경우 보고서에서 다루는 거래 유형(예: 구매 거래, 청구 거래, 환불)
• 선불 잔액 보고서의 경우 보고서가 적용되는 개발자
• 수익 보고서의 경우 보고서가 적용되는 API 제품 번들 (또는 API 패키지), 제품, 요금제, 애플리케이션
• 수익 또는 변동 보고서의 경우 보고서에 적용되는 통화
• 결제, 선불 잔액 또는 수익 보고서의 경우 보고서가 요약 보고서인지 상세 보고서인지와 무관합니다.
• 수익 요약 보고서의 경우 보고서에 맞춤 거래 속성을 포함합니다.

보고서 기준의 전체 목록은 보고서 구성 옵션을 참고하세요.

예를 들어 다음은 2015년 7월의 거래 활동을 요약한 수익 보고서를 생성합니다. 보고서에는 transactionTypes 속성에 지정된 다양한 거래 유형이 포함되어 있으며 특히 Payment API 제품 번들 및 Payment API 제품에 적용됩니다. 보고서 정의에 특정 개발자나 애플리케이션이 지정되어 있지 않으므로 보고서가 모든 개발자와 애플리케이션에 적용됩니다. currencyOption 속성이 LOCAL로 설정되어 있으므로 보고서의 각 줄이 해당 요금제의 통화를 사용하여 표시됩니다. 또한 groupBy 속성은 보고서의 열이 PACKAGE, PRODUCT, DEVELOPER, APPLICATION, RATEPLAN (보고서에 요금제 이름 및 ID 포함) 순서로 그룹화되도록 지정합니다.

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

다음은 2015년 6월 개발자 DEV FIVE의 활동을 보여주는 자세한 결제 보고서를 생성합니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

API를 사용하여 보고서 구성 보기

조직의 특정 보고서 구성 또는 모든 보고서 구성을 볼 수 있습니다. 개별 개발자의 보고서 구성도 볼 수 있습니다.

조직의 특정 보고서 구성을 보려면 /organizations/{org_name}/report-definitions/{report_definition_id}에 GET 요청을 실행합니다. 여기서 {report_definition_id}는 특정 보고서 구성을 식별합니다 (ID는 보고서 구성을 만들 때 응답에 반환됨). 예를 들면 다음과 같습니다.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

조직의 보고서 구성을 모두 보려면 /organizations/{org_name}/report-definitions에 GET 요청을 보내세요.

다음 쿼리 매개변수를 전달하여 결과를 필터링하고 정렬할 수 있습니다.

예를 들어 다음은 조직의 보고서 구성을 반환하고 최대 5개의 보고서 구성으로 검색을 제한합니다.

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

응답은 다음과 같아야 합니다(응답의 일부만 표시됨).

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

특정 개발자의 보고서 구성을 보려면 /organizations/{org_name}/developers/{dev_id}/report-definitions에 GET 요청을 실행합니다. 여기서 {dev_id}는 개발자 ID입니다. 요청할 때 위에 설명된 쿼리 매개변수를 지정하여 데이터를 필터링하고 정렬할 수 있습니다.

예를 들어 다음은 특정 개발자의 보고서 구성을 반환하고 보고서 이름별로 응답을 정렬합니다.

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

API를 사용하여 보고서 구성 업데이트

보고서 구성을 업데이트하려면 /organizations/{org_name}/report-definitions/{report_definition_id}에 PUT 요청을 실행합니다. 여기서 {report_definition_id}는 특정 보고서 구성을 식별합니다. 업데이트 시 업데이트된 구성 값과 보고서 구성의 ID를 요청 본문에 지정해야 합니다. 예를 들어 다음 요청은 보고서를 요약 보고서로 업데이트합니다(업데이트된 속성이 강조표시됨).

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

응답은 다음과 같아야 합니다(응답의 일부만 표시됨).

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

API를 사용하여 보고서 구성 삭제

보고서 구성을 삭제하려면 /organizations/{org_namer}/report-definitions/{report_definition_id}에 DELETE 요청을 실행합니다. 여기서 {report_definition_id}는 삭제할 보고서 구성의 ID입니다. 예를 들면 다음과 같습니다.

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

API를 사용하여 보고서 생성

보고서를 구성한 후 쉼표로 구분된 값(CSV) 파일 형식으로 보고서를 생성하여 볼 수 있습니다.

보고서를 생성하려면 organizations/{org_id}/{report_type}에 POST 요청을 실행하세요. 여기서 {report_type}는 생성할 보고서 유형을 지정합니다. 유형은 다음과 같습니다.

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

예를 들어 결제 보고서를 생성하려면 organizations/{org_name}/billing-reports에 POST 요청을 실행합니다.

모든 유형의 보고서에 대한 요청 본문에서 보고서의 검색 기준을 지정합니다. mintCriteria 속성을 사용하여 검색 기준을 지정합니다. 자세한 내용은 기준 구성 옵션을 참고하세요.

예를 들어 다음 요청은 보고서 시작일 및 종료일, 거래 유형과 같은 다양한 기준을 기반으로 수익 보고서를 검색합니다.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

발견되면 수익 보고서가 CSV 파일 형식으로 생성됩니다. 다음은 보고서 출력의 예입니다.

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

API를 사용하여 수익 보고서에 개발자 맞춤 속성 포함

수익 보고서의 경우에만 개발자에 대해 맞춤 속성이 정의된 경우 보고서에 맞춤 속성을 포함할 수 있습니다. 앱 개발자 관리에 설명된 대로 조직에 개발자를 추가할 때 커스텀 속성을 정의합니다.

수익 보고서에 맞춤 속성을 포함하려면 organizations/{org_name}/revenue-reports에 POST 요청을 실행하고 요청 본문에 devCustomAttributes 배열을 포함합니다.

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

참고: devCustomAttributes 배열에 사전 정의된 MINT_* 및 ADMIN_* 속성을 지정하지 마세요.

예를 들어 다음 예에는 보고서에 세 가지 맞춤 속성인 BILLING_TYPE, SFID, ORG_EXT가 포함되어 있습니다 (개발자에게 정의된 경우).

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

다음은 두 맞춤 속성의 값이 포함된 보고서 출력의 예입니다.

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

API를 사용하여 거래 활동 보고

/organizations/{org_name}/transaction-search에 POST 요청을 실행하여 조직의 거래 활동을 볼 수 있습니다. 요청할 때 검색 기준을 지정해야 합니다. 기준으로 지정할 수 있는 항목은 다음과 같습니다.

• 거래가 발행된 하나 이상의 API 제품의 ID입니다.
• 거래가 이루어진 결제 연도와 월입니다.
• 거래를 실행한 개발자입니다.
• 구매 및 설정 수수료와 같은 거래 유형입니다.
• 성공 및 실패와 같은 트랜잭션의 상태입니다.

기준의 전체 목록은 기준 구성 옵션을 참고하세요.

예를 들어 다음은 특정 개발자가 결제 월(2015년 6월)에 발행한 거래를 반환합니다.

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

특정 기간에 거래 활동이 발생한 애플리케이션, 개발자, API 제품 번들 또는 API 제품을 확인할 수도 있습니다. 이 정보는 객체 유형별로 별도로 볼 수 있습니다. 예를 들어 지정된 시작일 및 종료일 내에 수익 창출 API 제품 번들의 API에 액세스하는 애플리케이션에 대한 정보를 구체적으로 확인할 수 있습니다.

트랜잭션 활동에 대한 정보를 보려면 다음 리소스 중 하나로 GET 요청을 실행합니다.

요청을 보낼 때 기간의 시작일과 종료일을 쿼리 매개변수로 지정해야 합니다. 예를 들어 다음 요청은 2015년 8월에 트랜잭션이 있는 개발자를 반환합니다.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

응답은 다음과 같아야 합니다(응답의 일부만 표시됨).

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

API의 보고서 구성 옵션

API에서 사용할 수 있는 보고서 구성 옵션은 다음과 같습니다.

기준 구성 옵션

mintCriteria 속성을 통해 보고서에 다음 구성 옵션을 사용할 수 있습니다.

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]