Настроить план распределения доходов

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Введение

В плане распределения дохода поставщик API делится с разработчиком процентом дохода, полученного от каждой транзакции (на основе валовой или чистой цены транзакции). При создании плана распределения дохода вам необходимо указать модель распределения, которая может быть фиксированной или гибкой, а также основу ценообразования (например, основана ли доля дохода на валовой или чистой цене транзакции). Вы устанавливаете брутто или чистую цену транзакции при создании политики записи транзакций .

В модели фиксированного распределения вы делитесь с разработчиком фиксированным процентом дохода, полученного от каждой транзакции (на основе валовой или чистой цены транзакции). В гибкой модели обмена вы делитесь с разработчиком переменным процентом дохода. Доля дохода зависит от дохода, полученного за определенный период времени. Процент, используемый при расчете доли дохода, может варьироваться в зависимости от суммы дохода, полученного от транзакций.

Указание деталей плана распределения доходов с помощью пользовательского интерфейса

Настройте планы распределения доходов, как описано ниже.

Указание деталей плана распределения доходов с помощью API

Подробности плана распределения дохода вы указываете при создании тарифного плана. Вы указываете детали в ratePlanDetails в теле запроса при вызове /organizations/{org_name}/monetization-packages/{package_id}/rate-plans . То, что вы указываете в ratePlanDetails , зависит от выбранной вами модели общего доступа: фиксированной или гибкой.

Указание деталей плана распределения доходов для модели фиксированного распределения

Чтобы реализовать модель фиксированного совместного использования, вы указываете в деталях тарифного плана следующее:

• Параметр рейтинга, указывающий, что тарифный план основан на транзакциях ( VOLUME ). VOLUME — значение по умолчанию.
• Тип измерения ( UNIT ), указывающий, что доля дохода фиксирована на единицу (т. е. она не зависит от объема транзакций, как в случае с гибкой моделью совместного использования).
• Тип дохода ( GROSS или NET ). Это указывает на то, основана ли доля дохода на валовой или чистой цене транзакции.
• Срок оплаты (например, 30 дней).
• Идентификатор вашей организации.
• «Базовая» или учетная валюта, которую использует ваша компания.
• Ставка тарифного плана, которая предоставляет подробную информацию о том, как рассчитывается доля дохода. Поскольку модель совместного использования основана на фиксированной ставке, вы указываете только одну ставку тарифного плана.

Полный список свойств тарифного плана см. в разделе Свойства конфигурации для получения подробной информации о тарифном плане .

В тарифе тарифного плана вы указываете:

• Тип ставки тарифного плана ( REVSHARE ).
• Процент, используемый для расчета доли дохода. Например, если вы укажете 80,5555, доля дохода составит 80,5555 %, то есть как поставщик API вы платите разработчику 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 дней).
• Идентификатор вашей организации.
• «Базовая» или учетная валюта, которую использует ваша компания.
• Продолжительность и тип продолжительности, которые вместе определяют период времени, в течение которого агрегируется доход (это также называется «базисом агрегирования»). Транзакции агрегируются на основе агрегирования (например, за 1 месяц) для расчета общего дохода и применимого диапазона доходов. Процент доли дохода, применяемый к каждой транзакции, зависит от ее диапазона доходов.
• Счетчики агрегирования, которые используются для определения применимого диапазона доходов.

Полный список свойств тарифного плана см. в разделе Свойства конфигурации для получения подробной информации о тарифном плане .

Для каждого тарифа тарифного плана вы указываете:

• Тип ставки тарифного плана для диапазона дохода ( REVSHARE ).
• Процент, используемый для расчета доли дохода для диапазона доходов. Например, если вы укажете 80,5555, доля дохода для диапазона доходов составит 80,5555 %, то есть как поставщик API вы платите разработчику 80,5555 % от цены, взимаемой за каждую транзакцию в этом диапазоне доходов.
• Начальная и конечная единицы диапазона доходов. Начальная единица определяет нижний предел диапазона доходов, а конечная единица определяет верхний предел диапазона доходов. Например, если вы укажете начальную единицу 0 и конечную единицу 1000, диапазон дохода будет охватывать доход от транзакций от 0 до 1000 в указанной валюте. Если валюта — доллары США, база агрегирования — 1 месяц, а процент для диапазона доходов — 80,5555 %, то для транзакций, приносящих доход до 1000 долларов США в месяц, доля дохода составляет 80,5555 % от цены транзакции.

  Если вы не укажете конечную единицу для конечного диапазона дохода, процентная доля для этого диапазона будет применяться ко всем транзакциям после того, как совокупный доход превысит начальную единицу для этого диапазона. Например, если начальная единица для последнего диапазона равна 1000 (предположим, доллары США), и вы не указываете конечную единицу для этого диапазона, процент дохода для диапазона применяется ко всем транзакциям, доход которых превышает 1000 долларов США в течение совокупного периода.

Полный список свойств тарифных планов см. в разделе Свойства конфигурации тарифных планов .

Например, ниже создается план распределения доходов с гибкой моделью распределения. Он определяет два диапазона доходов. Первая группа охватывает доход от транзакций на сумму более 1000 долларов США. Вторая группа охватывает доход от транзакций, превышающий 1000 долларов США. Процент доли доходов составляет 80,5555% для первого диапазона доходов и 90,5% для второго диапазона доходов. Доля дохода зависит от чистой цены транзакции. Базис агрегирования – 1 месяц. Срок действия контракта вступает в силу 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"
}