Định cấu hình kế hoạch chia sẻ doanh thu

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Giới thiệu

Trong một kế hoạch chia sẻ doanh thu, nhà cung cấp API sẽ chia sẻ với nhà phát triển một tỷ lệ phần trăm doanh thu được tạo ra từ mỗi giao dịch (dựa trên giá gộp hoặc giá thực của một giao dịch). Khi tạo một kế hoạch chia sẻ doanh thu, bạn cần chỉ định một mô hình chia sẻ (có thể là cố định hoặc linh hoạt) và cơ sở định giá (chẳng hạn như việc tỷ lệ chia sẻ doanh thu dựa trên giá gộp hay giá ròng của một giao dịch). Bạn đặt giá gộp hoặc giá ròng cho giao dịch khi tạo chính sách ghi lại giao dịch.

Trong mô hình chia sẻ cố định, bạn chia sẻ với nhà phát triển một tỷ lệ phần trăm cố định doanh thu được tạo ra từ mỗi giao dịch (dựa trên giá gộp hoặc giá thực của một giao dịch). Trong mô hình chia sẻ linh hoạt, bạn chia sẻ với nhà phát triển một tỷ lệ phần trăm doanh thu có thể thay đổi. Tỷ lệ chia sẻ doanh thu phụ thuộc vào doanh thu được tạo ra trong một khoảng thời gian. Tỷ lệ phần trăm được dùng trong phép tính chia sẻ doanh thu có thể thay đổi tuỳ thuộc vào số tiền doanh thu được tạo ra từ các giao dịch.

Chỉ định thông tin chi tiết về kế hoạch chia sẻ doanh thu bằng giao diện người dùng

Định cấu hình kế hoạch chia sẻ doanh thu như mô tả bên dưới.

Chỉ định thông tin chi tiết về kế hoạch chia sẻ doanh thu bằng API

Bạn chỉ định thông tin chi tiết về kế hoạch chia sẻ doanh thu khi tạo gói giá. Bạn chỉ định thông tin chi tiết trong thuộc tính ratePlanDetails trong nội dung yêu cầu khi gọi /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Nội dung bạn chỉ định trong thuộc tính ratePlanDetails phụ thuộc vào mô hình chia sẻ bạn chọn: cố định hoặc linh hoạt.

Nêu rõ thông tin chi tiết về kế hoạch chia sẻ doanh thu cho mô hình chia sẻ cố định

Để triển khai mô hình chia sẻ cố định, bạn chỉ định những thông tin sau trong phần thông tin chi tiết về gói giá:

• Một tham số xếp hạng cho biết rằng gói giá dựa trên giao dịch (VOLUME). VOLUME là giá trị mặc định.
• Một loại đo lường (UNIT) cho biết tỷ lệ chia sẻ doanh thu được cố định theo đơn vị (tức là không dựa trên số lượng giao dịch, như trường hợp của mô hình chia sẻ linh hoạt).
• Loại doanh thu (GROSS hoặc NET). Thông tin này cho biết phần chia sẻ doanh thu dựa trên giá gộp hay giá ròng của một giao dịch.
• Khoảng thời gian đến hạn thanh toán (ví dụ: 30 ngày).
• Mã nhận dạng của tổ chức.
• "Cơ sở" hoặc đơn vị tiền tệ kế toán mà công ty của bạn sử dụng.
• Một mức giá trong gói giá cung cấp thông tin chi tiết về cách tính tỷ lệ chia sẻ doanh thu. Vì mô hình chia sẻ dựa trên một mức giá cố định, nên bạn chỉ cần chỉ định một mức giá của gói giá.

Hãy xem phần Thuộc tính cấu hình cho thông tin chi tiết về gói giá để biết danh sách đầy đủ các thuộc tính thông tin chi tiết về gói giá.

Trong giá của gói giá, bạn chỉ định:

• Loại giá của gói giá (REVSHARE).
• Tỷ lệ phần trăm dùng để tính phần doanh thu chia sẻ. Ví dụ: nếu bạn chỉ định 80,5555, thì tỷ lệ chia sẻ doanh thu là 80,5555%, tức là với tư cách là nhà cung cấp API, bạn sẽ trả cho nhà phát triển 80,5555% giá của mỗi giao dịch (hoặc nếu dựa trên một thuộc tính tùy chỉnh như số lượng byte được truyền trong một giao dịch, bạn sẽ trả cho nhà phát triển 80,5555% giá của việc truyền số lượng byte được chỉ định).
• Đơn vị bắt đầu của ứng dụng tỷ lệ (0). Điều này có nghĩa là tỷ lệ được áp dụng cho từng giao dịch, bắt đầu từ giao dịch đầu tiên.

Hãy xem Các thuộc tính cấu hình cho kế hoạch giá để biết danh sách đầy đủ các thuộc tính của kế hoạch giá.

Ví dụ: đoạn mã sau đây tạo một kế hoạch chia sẻ doanh thu với mô hình chia sẻ cố định. Tỷ lệ phần trăm chia sẻ doanh thu là 80,5555%. Phần chia sẻ doanh thu dựa trên giá ròng của một giao dịch. Hợp đồng có hiệu lực từ ngày 15 tháng 9 năm 2013 và bạn phải thanh toán trong vòng 30 ngày. (Các thông tin chi tiết liên quan đến việc chia sẻ doanh thu được làm nổi bật.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "setUpFee": 10,
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Phản hồi sẽ có dạng như sau (chỉ một phần phản hồi được hiển thị):

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

Nêu rõ thông tin chi tiết về kế hoạch chia sẻ doanh thu cho mô hình chia sẻ linh hoạt

Trong mô hình chia sẻ linh hoạt, bạn chỉ định thông tin chi tiết về gói giá, bao gồm một hoặc nhiều mức giá của gói giá. Mỗi mức giá trong gói giá bao gồm một phạm vi doanh thu giao dịch (mỗi phạm vi được gọi là "dải doanh thu"). Bạn chỉ định tỷ lệ phần trăm chia sẻ doanh thu cho từng khoảng doanh thu.

Ngoài giá của gói giá, bạn cũng chỉ định những thông tin sau trong phần thông tin chi tiết về gói giá:

• Một tham số xếp hạng cho biết rằng gói giá dựa trên giao dịch (VOLUME). VOLUME là giá trị mặc định.
• Một loại đo lường (VOLUME) cho biết rằng phần chia sẻ doanh thu không dựa trên số lượng giao dịch (tức là không cố định, như trường hợp của mô hình chia sẻ cố định).
• Loại doanh thu (GROSS hoặc NET). Thông tin này cho biết phần chia sẻ doanh thu dựa trên giá gộp hay giá ròng của một giao dịch.
• Khoảng thời gian đến hạn thanh toán (ví dụ: 30 ngày).
• Mã nhận dạng của tổ chức.
• "Cơ sở" hoặc đơn vị tiền tệ kế toán mà công ty của bạn sử dụng.
• Thời lượng và loại thời lượng cùng nhau chỉ định khoảng thời gian mà doanh thu được tổng hợp (còn được gọi là "cơ sở tổng hợp"). Các giao dịch được tổng hợp theo cơ sở tổng hợp (ví dụ: 1 tháng) để tính tổng doanh thu và dải doanh thu áp dụng. Tỷ lệ phần trăm doanh thu chia sẻ được áp dụng cho mỗi giao dịch tuỳ thuộc vào dải doanh thu của giao dịch đó.
• Bộ đếm tổng hợp được dùng để xác định dải doanh thu áp dụng.

Hãy xem phần Thuộc tính cấu hình cho thông tin chi tiết về gói giá để biết danh sách đầy đủ các thuộc tính thông tin chi tiết về gói giá.

Đối với mỗi mức giá trong gói giá, bạn chỉ định:

• Loại giá của gói giá cho dải doanh thu (REVSHARE).
• Tỷ lệ phần trăm dùng để tính phần doanh thu chia sẻ cho dải doanh thu. Ví dụ: nếu bạn chỉ định 80,5555, thì tỷ lệ chia sẻ doanh thu cho dải doanh thu đó là 80,5555%, tức là với tư cách là nhà cung cấp API, bạn sẽ trả cho nhà phát triển 80,5555% giá của mỗi giao dịch trong dải doanh thu đó.
• Đơn vị bắt đầu và kết thúc của dải doanh thu. Đơn vị bắt đầu chỉ định giới hạn dưới của một dải doanh thu, còn đơn vị kết thúc chỉ định giới hạn trên của dải doanh thu. Ví dụ: nếu bạn chỉ định đơn vị bắt đầu là 0 và đơn vị kết thúc là 1000, thì dải doanh thu sẽ bao gồm doanh thu từ giao dịch lớn hơn 0 và tối đa là 1000 theo đơn vị tiền tệ được chỉ định. Nếu đơn vị tiền tệ là đô la Mỹ, cơ sở tổng hợp là 1 tháng và tỷ lệ phần trăm cho dải doanh thu là 80,5555%, thì đối với những giao dịch tạo ra doanh thu lên đến 1.000 USD trong một tháng, tỷ lệ chia sẻ doanh thu là 80,5555% giá giao dịch.

  Nếu bạn không chỉ định đơn vị kết thúc cho dải doanh thu cuối cùng, thì tỷ lệ phần trăm chia sẻ cho dải đó sẽ được áp dụng cho tất cả giao dịch sau khi tổng doanh thu vượt quá đơn vị bắt đầu cho dải đó. Ví dụ: nếu đơn vị bắt đầu cho dải cuối cùng là 1000 (giả sử là đô la Mỹ) và bạn không chỉ định đơn vị kết thúc cho dải đó, thì tỷ lệ phần trăm doanh thu cho dải đó sẽ được áp dụng cho tất cả các giao dịch có doanh thu trên 1000 đô la Mỹ trong khoảng thời gian tổng hợp.

Hãy xem Các thuộc tính cấu hình cho kế hoạch giá để biết danh sách đầy đủ các thuộc tính của kế hoạch giá.

Ví dụ: đoạn mã sau đây tạo một kế hoạch chia sẻ doanh thu với mô hình chia sẻ linh hoạt. Nó chỉ định 2 dải doanh thu. Nhóm đầu tiên bao gồm doanh thu từ giao dịch lớn hơn 0 đến 1.000 đô la Mỹ. Mức thứ hai áp dụng cho doanh thu giao dịch trên 1.000 USD. Tỷ lệ chia sẻ doanh thu là 80,5555% cho nhóm doanh thu đầu tiên và 90,5% cho nhóm doanh thu thứ hai. Phần chia sẻ doanh thu dựa trên giá ròng của một giao dịch. Cơ sở tổng hợp là 1 tháng. Thời hạn hợp đồng có hiệu lực từ ngày 15 tháng 9 năm 2013 và thời hạn thanh toán là 30 ngày. (Thông tin chi tiết liên quan đến việc chia sẻ doanh thu được làm nổi bật.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",   
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Phản hồi sẽ có dạng như sau (chỉ một phần phản hồi được hiển thị):

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}