إعداد خطة حصة الأرباح

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

مقدمة

في خطة مشاركة الأرباح، يشارك مقدّم واجهة برمجة التطبيقات مع المطوّر نسبة مئوية من الأرباح الناتجة من كل معاملة (استنادًا إلى السعر الإجمالي أو الصافي للمعاملة). عند إنشاء خطة لمشاركة الأرباح، عليك الإشارة إلى نموذج المشاركة، والذي يمكن أن يكون ثابتًا أو مرنًا، وإلى أساس التسعير (مثل ما إذا كانت حصة الأرباح تستند إلى السعر الإجمالي أو الصافي للمعاملة). يمكنك تحديد السعر الإجمالي أو الصافي للمعاملة عند إنشاء سياسة تسجيل المعاملات.

في نموذج المشاركة الثابتة، تشارك مع المطوّر نسبة مئوية ثابتة من الأرباح الناتجة من كل معاملة (استنادًا إلى السعر الإجمالي أو الصافي للمعاملة). في نموذج المشاركة المرن، تشارك مع المطوّر نسبة مئوية متغيّرة من الأرباح. تعتمد حصة الأرباح على الأرباح التي يتم تحقيقها خلال فترة زمنية معيّنة. يمكن أن تختلف النسبة المئوية المستخدَمة في حساب حصة الأرباح استنادًا إلى مقدار الأرباح الناتجة عن المعاملات.

تحديد تفاصيل خطة مشاركة الأرباح باستخدام واجهة المستخدم

اضبط خطط مشاركة الأرباح كما هو موضّح أدناه.

تحديد تفاصيل خطة حصة الأرباح باستخدام واجهة برمجة التطبيقات

يمكنك تحديد تفاصيل خطة مشاركة الأرباح عند إنشاء خطة الأسعار. يمكنك تحديد التفاصيل في السمة ratePlanDetails ضمن نص الطلب في طلب موجَّه إلى /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. يعتمد ما تحديده في سمة ratePlanDetails على نموذج المشاركة الذي تختاره: ثابت أو مرن.

تحديد تفاصيل خطة مشاركة الأرباح لنموذج مشاركة ثابت

لتنفيذ نموذج المشاركة الثابتة، يمكنك تحديد ما يلي في تفاصيل خطة الأسعار:

• مَعلمة تقييم تشير إلى أنّ خطة الأسعار تستند إلى المعاملات (VOLUME). VOLUME هي القيمة التلقائية.
• نوع قياس حصة الأرباح (UNIT) يشير إلى أنّ حصة الأرباح ثابتة لكل وحدة (أي أنها لا تستند إلى حجم المعاملات، كما هو الحال مع نموذج المشاركة المرن).
• نوع الأرباح (GROSS أو NET): يشير ذلك إلى ما إذا كانت حصة الأرباح تستند إلى السعر الإجمالي أو الصافي للمعاملة.
• فترة استحقاق الدفع (على سبيل المثال، 30 يومًا)
• رقم تعريف مؤسستك.
• العملة "الأساسية" أو العملة المحاسبية التي تستخدمها شركتك.
• سعر خطة أسعار يقدّم تفاصيل عن كيفية احتساب حصة الأرباح ولأنّ نموذج المشاركة يستند إلى سعر ثابت، يمكنك تحديد سعر واحد فقط لخطة الأسعار.

اطّلِع على خصائص الضبط لتفاصيل خطة الأسعار للحصول على قائمة كاملة بخصائص تفاصيل خطة الأسعار.

في سعر خطة الأسعار، يمكنك تحديد ما يلي:

• نوع سعر خطة الأسعار (REVSHARE).
• النسبة المئوية المستخدَمة لاحتساب حصة الأرباح. على سبيل المثال، إذا حددت 80.5555، تكون حصة الأرباح 80.5555%، أي أنك، بصفتك موفِّر واجهة برمجة التطبيقات، عليك أن تدفع للمطوِّر نسبة 80.5555% من السعر الذي يتم تحصيله مقابل كل معاملة (أو إذا كانت الرسوم مستندة إلى سمة مخصّصة مثل عدد وحدات البايت التي يتم نقلها في إحدى المعاملات، يتم تسديد 80.5555% للمطوِّر من السعر المحدّد من المبلغ المحدّد مقابل كل معاملة بايت).
• وحدة البدء لتطبيق السعر (0). وهذا يعني أنّه يتم تطبيق السعر على كل معاملة، بدءًا من المعاملة الأولى.

اطّلِع على سمات الضبط لخطط الأسعار للحصول على قائمة كاملة بسمات خطط الأسعار.

على سبيل المثال، ينشئ الإجراء التالي خطة مشاركة الأرباح باستخدام نموذج مشاركة ثابت. تبلغ النسبة المئوية لحصة الأرباح %80.5555. تستند حصة الأرباح إلى صافي سعر المعاملة. يسري العقد اعتبارًا من 15 أيلول (سبتمبر) 2013، ويجب سداد الدفعة خلال 30 يومًا. (يتم تمييز التفاصيل المتعلّقة بمشاركة الأرباح).

$ 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

يجب أن يبدو الرد هكذا (يظهر جزء فقط من الرد):

{
  "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"
}

تحديد تفاصيل خطة مشاركة الأرباح لنموذج مشاركة مرن

في نموذج المشاركة المرن، يمكنك تحديد تفاصيل خطة الأسعار التي تتضمّن تعرفة واحدة أو أكثر من تعرفات خطة الأسعار. يغطّي كلّ سعر من أسعار الخطة نطاقًا من أرباح المعاملات (يُسمّى كلّ نطاق "مجموعة أرباح"). يمكنك تحديد نسبة مئوية لحصة الأرباح لكل نطاق أرباح.

بالإضافة إلى تعرفات خطة الأسعار، يمكنك تحديد ما يلي في تفاصيل خطة الأسعار:

• مَعلمة تقييم تشير إلى أنّ خطة الأسعار تستند إلى المعاملات (VOLUME). VOLUME هي القيمة التلقائية.
• نوع قياس حصة الأرباح (VOLUME) يشير إلى أنّ حصة الأرباح لا تستند إلى حجم المعاملات (أي أنها غير ثابتة، كما هو الحال مع نموذج المشاركة الثابتة).
• نوع الأرباح (GROSS أو NET): يشير ذلك إلى ما إذا كانت حصة الأرباح تستند إلى السعر الإجمالي أو الصافي للمعاملة.
• فترة استحقاق الدفع (على سبيل المثال، 30 يومًا)
• رقم تعريف مؤسستك.
• العملة "الأساسية" أو العملة المحاسبية التي تستخدمها شركتك.
• مدّة ونوع مدّة يحدّدان معًا الفترة الزمنية التي يتم تجميع الأرباح خلالها (يُشار إليها أيضًا باسم "أساس التجميع"). يتم تجميع المعاملات على أساس التجميع (على سبيل المثال، شهر واحد) لاحتساب إجمالي الأرباح ومجموعة الأرباح السارية. تعتمد النسبة المئوية لحصة الأرباح المطبَّقة على كل معاملة على نطاق الأرباح فيها.
• عدادات التجميع التي تُستخدَم لتحديد نطاق الأرباح الساري

اطّلِع على خصائص الضبط لتفاصيل خطة الأسعار للحصول على قائمة كاملة بخصائص تفاصيل خطة الأسعار.

لكل سعر من أسعار الخطة، يمكنك تحديد ما يلي:

• نوع معدّل خطة الأسعار لنطاق الأرباح (REVSHARE)
• النسبة المئوية المستخدَمة لاحتساب حصة الأرباح في نطاق الأرباح على سبيل المثال، إذاحددت ‎80.5555، تكون حصة الأرباح لفئة الأرباح هذه هي ‎80.5555%، أي أنّك بصفتك مقدّم واجهة برمجة التطبيقات، تدفع للمطوّر ‎80.5555% من السعر الذي يتم تحصيله مقابل كل معاملة في فئة الأرباح هذه.
• الوحدة الأولى والوحدة الأخيرة لفئة الأرباح تحدّد الوحدة الأولى الحدّ الأدنى لنطاق الأرباح، بينما تحدّد الوحدة الأخيرة الحدّ الأقصى لنطاق الأرباح. على سبيل المثال، إذا حدّدت وحدة بداية 0 ووحدة نهاية 1000، سيشمل نطاق الأرباح أرباح المعاملات التي تزيد عن 0 وتصل إلى 1000 بالعملة المحدّدة. إذا كانت العملة هي الدولار الأمريكي، يكون أساس التجميع على أساس شهر واحد، وتكون النسبة المئوية لنطاق الأرباح 80.5555%، وبالتالي بالنسبة إلى المعاملات التي تحقق ما يصل إلى 1000 دولار أمريكي في الشهر، تكون حصة الأرباح هي 80.5555% من سعر المعاملة.

  في حال عدم تحديد وحدة نهائية لفئة الأرباح النهائية، يتم تطبيق النسبة المئوية للحصة على جميع المعاملات بعد أن تتجاوز الأرباح الإجمالية الوحدة الافتتاحية لفئة الأرباح هذه. على سبيل المثال، إذا كانت الوحدة الأساسية للفئة الأخيرة هي 1000 (بالدولار الأمريكي)، ولم تحدِّد وحدة نهائية لهذه الفئة، يتم تطبيق النسبة المئوية للإيرادات للفئة على جميع المعاملات التي تتجاوز أرباحها 1000 دولار أمريكي خلال المدّة المُجمّعة .

اطّلِع على سمات الضبط لخطط الأسعار للحصول على قائمة كاملة بسمات خطط الأسعار.

على سبيل المثال، يؤدي ما يلي إلى إنشاء خطة حصة أرباح مع نموذج مشاركة مرن. وهي تحدّد نطاقَين للأرباح. تغطي النطاق الأول أرباح المعاملات التي تزيد عن 1,000 دولار أمريكي. يشمل النطاق الثاني الأرباح الناتجة عن المعاملات التي تتجاوز قيمتها 1,000 دولار أمريكي. تبلغ النسبة المئوية لحصّة الأرباح ‎80.5555% لفئة الأرباح الأولى و‎90.5% لفئة الأرباح الثانية. تستند حصة الأرباح إلى صافي سعر المعاملة. يكون أساس التجميع شهرًا واحدًا. يبدأ سريان العقد في 15 أيلول (سبتمبر) 2013، ويكون تاريخ استحقاق الدفع بعد 30 يومًا. (يتم تمييز التفاصيل المتعلّقة بمشاركة الأرباح).

$ 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

من المفترض أن يظهر الردّ على النحو التالي (يتم عرض جزء من الردّ فقط):

{
  "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"
}