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

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

Введение

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

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

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

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

Край

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

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

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

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

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

Классический Edge (частное облако)

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

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

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

    • Планы для конкретных продуктов позволяют настраивать параметры тарифного плана для каждого API-продукта в отдельности.
    • Универсальный план для всех продуктов позволяет настроить параметры тарифного плана для всех продуктов API.
  4. Нажмите «Распределение дохода» , чтобы просмотреть общий тарифный план, или выберите тарифный план для каждого конкретного API-продукта.

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

    Открывается окно «Распределение доходов».

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

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

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

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

    Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.

    Валюта

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

    Тип ценообразования

    Основа для распределения выручки. Выберите «Валовая» или «Чистая». Если вы выберете «Валовая», распределение выручки будет основано на проценте от валовой цены сделки. Если вы выберете «Чистая», распределение выручки будет основано на проценте от чистой цены сделки. Примечание : Валовую или чистую цену сделки вы устанавливаете при создании политики регистрации сделок .

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

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

    Для гибкой модели совместного использования:

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

    В окне «Распределение выручки по общим статьям» введите следующую информацию:

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

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

    Диапазоны доходов

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

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

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

    Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.

    Валюта

    Базовая или учетная валюта, используемая вашей организацией. Это поле предварительно задается значением поля «Валюта» в профиле организации.

    Тип ценообразования

    Основа для распределения выручки. Выберите «Валовая» или «Чистая». Если вы выберете «Валовая», распределение выручки будет основано на проценте от валовой цены сделки. Если вы выберете «Чистая», распределение выручки будет основано на проценте от чистой цены сделки. Примечание : Валовую или чистую цену сделки вы устанавливаете при создании политики регистрации сделок .

    Доля в процентах для диапазонов выручки

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

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

Введение

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

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

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

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

Край

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

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

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

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

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

Классический Edge (частное облако)

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

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

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

    • Планы для конкретных продуктов позволяют настраивать параметры тарифного плана для каждого API-продукта в отдельности.
    • Универсальный план для всех продуктов позволяет настроить параметры тарифного плана для всех продуктов API.
  4. Нажмите «Распределение дохода» , чтобы просмотреть общий тарифный план, или выберите тарифный план для каждого конкретного API-продукта.

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

    Открывается окно «Распределение доходов».

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

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

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

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

    Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.

    Валюта

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

    Тип ценообразования

    Основа для распределения выручки. Выберите «Валовая» или «Чистая». Если вы выберете «Валовая», распределение выручки будет основано на проценте от валовой цены сделки. Если вы выберете «Чистая», распределение выручки будет основано на проценте от чистой цены сделки. Примечание : Валовую или чистую цену сделки вы устанавливаете при создании политики регистрации сделок .

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

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

    Для гибкой модели совместного использования:

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

    В окне «Распределение выручки по общим статьям» введите следующую информацию:

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

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

    Диапазоны доходов

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

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

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

    Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.

    Валюта

    Базовая или учетная валюта, используемая вашей организацией. Это поле предварительно задается значением поля «Валюта» в профиле организации.

    Тип ценообразования

    Основа для распределения выручки. Выберите «Валовая» или «Чистая». Если вы выберете «Валовая», распределение выручки будет основано на проценте от валовой цены сделки. Если вы выберете «Чистая», распределение выручки будет основано на проценте от чистой цены сделки. Примечание : Валовую или чистую цену сделки вы устанавливаете при создании политики регистрации сделок .

    Доля в процентах для диапазонов выручки

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