API를 사용한 구매 요금제

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서.
정보

이 섹션에서는 공시 요금제를 구매하고 구매한 요금제를 만료 또는 취소하는 방법을 설명합니다. 원하는 경우 API를 사용하여 설정할 수 있습니다

API를 사용하여 공시 요금제 구매

요금제가 게시된 후 개발자나 회사는 POST 요청을 실행하여 /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans, 여기서 {org_name}은 조직의 이름입니다. {developer_or_company_id}는 개발자 또는 회사의 ID입니다.

<ph type="x-smartling-placeholder">

요금제를 구매할 때 설정 수수료를 면제하려면 waivefees 쿼리 매개변수를 설정하세요. true에게 전송합니다. 이 플래그는 개발자가 수익 창출로 이전할 때 유용합니다. 개발자를 Google Cloud 콘솔로 수익 창출에 대해 자세히 알아보세요.

다음 표에는 요청 본문, 기본값, 필수 여부 등이 포함됩니다.

이름 설명 기본값 필수 여부
startDate

요금제가 시작되는 날짜입니다. 예: 2017-03-24.

해당 사항 없음
endDate

요금제가 종료되는 날짜입니다. 예: 2017-09-24.

요금제는 다음 날짜의 오늘 자정까지 적용됩니다. 지정된 날짜입니다. 예를 들어 2017년 12월 1일에 요금제를 만료하려는 경우 endDate 값을 2017년 11월 30일에 만료됩니다. 이 이 경우 요금제가 2017년 11월 30일 자정에 만료됩니다. 모든 요청 2017년 12월 1일부터 차단됩니다.

해당 사항 없음 아니요
developer

다음과 같은 개발자 또는 회사의 ID를 정의하는 id 속성입니다. 요금제를 구매합니다.

해당 사항 없음
quotaTarget

앱 개발자에게 허용된 거래 횟수입니다. 이 경우, 목표 수의 몇 퍼센트를 기반으로 알림이 전송되는지 90%, 100%, 150%와 같이 설정할 수 있습니다 추가 거래는 도달할 수 있습니다

이 값을 양의 정수 값 또는 0으로 설정하여 앱에 대한 알림을 사용 중지합니다. 있습니다.

0 아니요
ratePlan

요금제 ID를 정의하는 id 속성입니다.

요금제 ID는 표시 이름과 다릅니다. 요금제 세부정보를 보려면 다음 단계를 따르세요. 자세한 내용은 페이지를 참조하세요. 요금제 페이지 살펴보기

해당 사항 없음
suppressWarning

개발자가 구매를 시도할 때 오류를 억제할지 여부를 지정하는 플래그 구매한 다른 요금제와 중복되는 요금제가 있는 경우 값은 있습니다.

  • true - 수익 창출을 사용하면 개발자는 충돌하는 API 제품이 포함된 API 패키지가 있어야 합니다. 그런 다음 개발자를 위한 새 API 패키지를 구매할 수 있습니다.
  • false - 요금제를 사용하는 것이 좋습니다.
해당 사항 없음 아니요
waveTerminationCharge

활성 요금제가 적용되는 경우 해지 수수료를 면제할지 여부를 지정하는 플래그 새 요금제 활성화의 일환으로 해지됨 값은 있습니다.

  • true - 활성 요금제가 해지되면 해지 수수료 면제 새 요금제 활성화의 일환으로
  • false - 활성 요금제가 다음에 해당하는 경우 해지 수수료를 면제하지 않음: 새 요금제 활성화의 일환으로 해지됨
해당 사항 없음 아니요

예를 들어 다음 요청은 location_&_messaging 요금제를 구매합니다. 지정된 개발자의 경우:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

이 예에서 suppressWarning 속성은 false로 설정되어 있습니다. 포함 이 경우 충돌 시 오류가 발생합니다. 예를 들어 개발자가 구매한 다른 요금제와 중복되는 요금제를 구매하려고 하면 오류가 발생합니다. 이 수익 창출을 위한 사용자 인터페이스를 제공하여 오류를 가로채고 해당하는 경우 개발자에게 연락하여 확인할 수 있도록 충돌 제품을 표시해야 합니다. 만약 suppressWarning을(를) true(으)로 설정하면 구매한 모든 항목이 수익 창출 기능을 통해 종료됩니다. 개발자가 충돌하는 제품이 포함된 API 패키지에 대한 요금제를 사용해야 합니다. 그런 다음 개발자를 위한 새 API 패키지를 구입할 수 있습니다.

다음 요청은 조정 가능한 알림 요금제를 구매하고 목표 수를 설정합니다. 4,000회로 늘어났습니다

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

위의 예시 중 하나에서 다음 오류 메시지가 반환되는 경우:

Developer legal name not specified. 

그런 다음 수익 창출 속성 MINT_DEVELOPER_ADDRESSMINT_DEVELOPER_LEGAL_NAME 그런 다음 API 호출을 반복합니다.

개발자가 API를 사용하여 구매한 요금제 만료

개발자가 구매한 요금제를 만료 (또는 취소)하려면 구매한 요금제를 업데이트하세요. 다음과 같은 요청 본문에서 endDate 속성을 지정합니다. PUT 요청을 실행하여 /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} 리소스

요금제는 해당 날짜 종료일까지 적용됩니다. 날짜를 지정합니다. 예를 들어 2017년 12월 1일에 요금제를 종료하려면 endDate 값을 설정합니다. 2017년 11월 30일에 만료됩니다. 이 경우 요금제가 2017년 11월 30일 자정에 만료됩니다. 12월 1일에 모든 요청이 2017년은 차단됩니다.

구매 시 응답에 {developer_rateplan_id}가 반환됩니다. 확인할 수 있습니다.

예를 들면 다음과 같습니다.

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

또는 {developer-rateplan-id}를 가져올 수 있습니다. GET 요청을 실행하여 개발자 요금제를 받는 사람: /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, 여기서 {developer_id}는 개발자의 이메일 주소입니다. 자세한 내용은 자세한 내용은 보기 개발자가 구매한 모든 요금제를 사용해야 합니다.

다음 요청은 종료일을 2017년 12월 1일로 업데이트합니다. 즉, 요금제는 2017년 11월 30일 자정에 만료됩니다. 2017년 12월 1일에 발생한 모든 요청은 님이 차단되었습니다.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'