Как настроить план распределения дохода

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

Введение

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

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

Как указать сведения о плане распределения дохода в интерфейсе

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

Edge

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

Поле Описание
Модель расчета Выберите один из следующих типов цен:
  • Валовая. Доля дохода рассчитывается как процент от валовой цены транзакции.
  • Чистая цена. Доля дохода рассчитывается как процент от чистой цены транзакции.
Примечание. Вы задаете цену (брутто или нетто) для транзакции, когда создаете правила регистрации транзакций.
Частота расчета Период времени, за который рассчитывается объем транзакций (или объем, связанный со специальным атрибутом). Выберите количество месяцев (от 1 до 24).
Как поделиться моделью Выберите одну из следующих моделей распределения дохода:
  • Фиксированная. Поставщик API делится с разработчиком фиксированным процентом дохода, полученного от каждой транзакции (на основе валовой или чистой цены транзакции).
  • Гибкая. Поставщик API делится с разработчиком переменной долей дохода. Доля дохода зависит от того, сколько вы заработали за определенный период. Процент, используемый при расчете доли дохода, может меняться в зависимости от суммы дохода, полученного от транзакций.
Фиксированная доля дохода Для фиксированной модели распределения дохода указывает процент, используемый для расчета доли дохода. Введите десятичное число (не более четырех знаков после запятой). Например, если вы введете 80,5555, то доля дохода составит 80,5555 %. Это означает, что как поставщик API вы будете выплачивать разработчику 80,5555% от цены, взимаемой за каждую транзакцию.
Диапазоны распределения дохода

Для гибкой модели обмена данными – один или несколько диапазонов дохода от транзакций (каждый диапазон – это "диапазон дохода"). Каждому диапазону дохода можно назначить долю дохода в процентах. Транзакции агрегируются на основе выбранного параметра, чтобы рассчитать общий доход и диапазон дохода для транзакции. Процент дохода, который применяется к каждой транзакции, зависит от диапазона дохода.

Укажите верхний предел первого диапазона, например 1000 (нижний предел по умолчанию – больше 0). Чтобы добавить дополнительные диапазоны, нажмите + Создать. Оставьте верхнюю границу последнего диапазона пустой, чтобы указать все транзакции после того, как совокупный доход превысит этот уровень.

Например, если в разделе "Диапазон дохода" вы указали два диапазона (>0–1000 и 1000 и выше), то для первого диапазона можно ввести значение 80,5555, а для второго – 90,5. Предположим, что валюта – доллары США. Затем для транзакций, приносящих до 1000 долларов США, доля дохода составляет 80,5555% от цены транзакции, а для транзакций, приносящих более 1000 долларов США, доля дохода составляет 90,5% от цены транзакции.

Классическая версия Edge (частное облако)

Чтобы настроить планы распределения дохода с помощью классического интерфейса Edge:

  1. Следуйте инструкциям по созданию тарифного плана.
  2. Чтобы настроить модель распределения дохода, в раскрывающемся списке "Тип тарифного плана" выберите Распределение дохода.
  3. Если выбранный пакет API включает несколько продуктов API, выберите один из следующих вариантов:

    Примечание. Если пакет API включает только один продукт API, этот шаг можно пропустить.

    • Планы для отдельных продуктов, чтобы настроить сведения о тарифных планах для каждого продукта API.
    • Generic Plan for All Products, чтобы настроить тарифный план для всех продуктов API.
  4. Нажмите Распределение дохода для общего тарифного плана или для каждого тарифного плана, относящегося к определенному продукту API.

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

    Откроется окно "Распределение дохода".

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

    Для модели с фиксированным распределением:

    Если вы выбрали фиксированную модель распределения дохода, в разделе "Цены" окна "Общее распределение дохода" укажите следующую информацию:

    Поле Описание
    Оператор (или организация)

    Название организации. Это поле заполняется автоматически на основе значения поля "Оператор (или организация)" в профиле организации.
    Страна

    Страна, в которой работает ваша организация. Это поле заполняется автоматически на основе значения поля "Страна" в профиле организации.
    Валюта

    Основная валюта, которую использует ваша компания. Это поле заполняется автоматически на основе значения поля "Валюта" в профиле организации.
    Тип ценообразования

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

    Фиксированная доля %

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

    Для модели гибкого доступа:

    Если вы выберете гибкую модель, в окне "Общий процент дохода" появятся дополнительные поля. Эти поля используются, чтобы задать основу для агрегирования и указать диапазоны дохода от транзакций, для которых можно применять разные доли дохода.

    В окне "Распределение дохода" укажите следующую информацию:

    Поле Описание
    Основа агрегирования

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

    Один или несколько диапазонов дохода от транзакций (каждый диапазон – это "диапазон дохода"). Каждому диапазону дохода можно назначить процент доли дохода (этот процент задается в поле "Диапазоны дохода" раздела "Цены"). Транзакции агрегируются на основе выбранного параметра, чтобы рассчитать общий доход и диапазон дохода для транзакции. Процент дохода, применяемый к каждой транзакции, зависит от ее диапазона дохода.

    Укажите верхний предел первого диапазона, например 1000 (нижний предел задан по умолчанию и больше 0). Нажмите "+", чтобы добавить второй диапазон, например "больше 1000 и до 2000". Чтобы добавить больше диапазонов, нажмите "+". Вы можете не указывать верхний предел для последней группы, чтобы включить в нее все транзакции, совершенные после того, как совокупный доход превысит указанный уровень.
    Цены
    Оператор (или организация)

    Название организации. Это поле заполняется автоматически на основе значения поля "Оператор (или организация)" в профиле организации.
    Страна

    Страна, в которой работает ваша организация. Это поле заполняется автоматически на основе значения поля "Страна" в профиле организации.
    Валюта

    Базовая валюта, которую использует ваша организация. Это поле заполняется автоматически на основе значения поля "Валюта" в профиле организации.
    Тип ценообразования

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

    Доля дохода для диапазонов дохода

    Процент, используемый для расчета доли дохода от транзакций в каждом диапазоне дохода. Для каждого диапазона указывается процент. Введите десятичное число (до четырех знаков после запятой). Например, если в разделе "Диапазон дохода" вы задали два диапазона (>0–1000 и 1000 и выше), то для диапазона >0–1000 можно ввести значение 80,5555, а для диапазона 1000 и выше – 90,5. Предположим, что валюта – доллары США. Затем для транзакций, приносящих до 1000 долларов США, доля дохода составляет 80,5555% от цены транзакции, а для транзакций, приносящих более 1000 долларов США, доля дохода составляет 90,5% от цены транзакции.
  6. Нажмите Применить и закрыть, чтобы сохранить сведения о распределении дохода и вернуться к окну "Стандартный тарифный план".
  7. Если вы используете тарифные планы для определенных продуктов API, настройте сведения о тарифных планах для дополнительных продуктов 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 дней).
  • Идентификатор организации.
  • Основная валюта, которую использует ваша компания.
  • Продолжительность и тип продолжительности, которые вместе определяют период времени, за который агрегируется доход (это также называется "базой агрегирования"). Транзакции агрегируются на основе выбранного периода (например, одного месяца), чтобы рассчитать общий доход и применимый диапазон дохода. Процент дохода, применяемый к каждой транзакции, зависит от ее диапазона дохода.
  • Счетчики агрегирования, которые используются для определения подходящего диапазона дохода.

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

Для каждого тарифа необходимо указать:

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

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

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

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