Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Введение
В тарифном плане с фиксированной ценой застройщик оплачивает каждую транзакцию. Для такого типа плана необходимо предоставить дополнительные сведения, такие как модель начисления платы и стоимость этой модели.
При желании вы можете указать бесплатный тарифный план для отдельных продуктов (а не для пакета API) — это можно сделать только для тарифного плана, специфичного для конкретного продукта.
Когда взимаются регулярные платежи и происходит сброс тарифных планов?
Тарифные планы могут включать как регулярные платежи, так и пакеты API (планы с ограничением объема и пакетные планы), в которых предусмотрено определенное время начисления платы и обнуления счетчиков пакетных планов. В следующей таблице описано, когда начисляются регулярные платежи и обнуляются счетчики пакетных планов. Если приложениям разработчиков запрещено совершать дальнейшие вызовы API из-за достижения определенного лимита транзакций, в это время счетчики вызовов API обнуляются, и приложения могут снова начать совершать вызовы.
| Если план предусматривает... | ...такое случается |
|---|---|
| Регулярная плата и сброс тарифного плана происходят первого числа каждого месяца (по умолчанию). Для ежемесячного начисления в определенный день создайте тарифный план с помощью API управления и укажите этот день с помощью свойства |
| Периодическая плата и обновление тарифного плана происходят каждые 7 дней после даты начала действия тарифного плана застройщика. |
| Периодическая плата и сброс тарифного плана происходят каждые X дней после даты начала действия тарифного плана застройщика. |
| Тарифные планы обновляются в соответствии с базой агрегирования, определенной в прайс-листе. Например, если разработчик начинает использовать тарифный план 19-го числа месяца, а база агрегирования — 1-й месяц, то использование пакета услуг обновляется каждый месяц 19-го числа. Обратите внимание, что день месяца может быть не всегда одним и тем же. Например, если тарифный план вступает в силу 31 декабря, то датой перерасчета становится 28-е число февраля в невисокосном году, поскольку в феврале всего 28 дней. 28-е число остается датой перерасчета с тех пор. |
Настройка тарифных планов с помощью пользовательского интерфейса.
Настройте тарифные планы, как описано ниже.
Край
Для настройки тарифного плана при его создании или редактировании выберите тип тарифного плана «Тарифный план» или «Тарифный план и распределение доходов» , а в разделе «Тарифный план» выберите одну из следующих моделей тарификации:
| модель зарядки | Описание |
| Единая ставка | Разработчику взимается фиксированная плата за каждую транзакцию. |
| Диапазон громкости | С разработчика взимается переменная плата, зависящая от объема транзакций. |
| Наборы | Разработчику взимается фиксированная сумма авансом за каждый пакет транзакций. Эта фиксированная сумма взимается независимо от того, был ли пакет использован полностью или нет. Примечание : Эта опция недоступна при выборе тарифной сетки и распределения доходов. |
Затем настройте следующую информацию в соответствии с выбранной моделью зарядки.
| Модель зарядки | Поле | Описание |
| Все | Частота вычислений | Период времени, за который рассчитывается объем транзакций (или объем, связанный с пользовательским атрибутом). Выберите количество месяцев (от 1 до 24 месяцев). |
| Единая ставка | Единая ставка | Тариф, взимаемый за каждую транзакцию. Введите десятичное число (с четырьмя знаками после запятой). Примечание : Количество десятичных знаков, которые можно указать для тарифа, можно настроить с помощью API (а не пользовательского интерфейса). Подробнее см. раздел «Настройка количества десятичных знаков для тарифов тарифных планов» . Например, если вы введете 0,10, а валюта — доллары США, с разработчика будет взиматься 0,10 доллара за каждую транзакцию (или, если это зависит от пользовательского атрибута, такого как количество байтов, передаваемых в транзакции, с разработчика будет взиматься 0,10 доллара за передачу указанного количества байтов). |
| Диапазон громкости | Диапазоны громкости | Один или несколько диапазонов объема транзакций (или на основе атрибутов клиента) (каждый диапазон — это «диапазон объема») для модели тарификации по диапазонам объема. Каждому диапазону объема может быть назначена ставка. Ставка применяется ко всем транзакциям в соответствующем диапазоне объема. Укажите верхний предел первого диапазона, например, до 1000 (нижний предел по умолчанию установлен на значение больше 0). Нажмите +Новый , чтобы добавить дополнительные полосы. Оставьте верхнюю границу итогового диапазона пустой, чтобы указать все транзакции, совершенные выше этого уровня. Примечание : Количество десятичных знаков, которые можно указать для тарифа, можно настроить с помощью API (а не пользовательского интерфейса). Подробнее см. раздел «Настройка количества десятичных знаков для тарифов тарифных планов» . Например, если в разделе «Диапазон объема» указаны два диапазона объема (>0-1000 и 1000 и выше), можно ввести 0,15 для диапазона >0-1000 и 0,10 для диапазона 1000 и выше. Если выбранная валюта — доллары США, курс для первых 1000 транзакций составит 0,15 доллара за каждую транзакцию, а для более чем 1000 транзакций — 0,10 доллара за каждую транзакцию. |
| Наборы | цены на пакеты API | Количество транзакций в пакете (или число, связанное с пользовательским атрибутом, например, общим количеством байтов, переданных в пакете). Каждому пакету может быть назначена цена. Цена применяется ко всему пакету. Укажите верхний предел для первого пакета, например, до 1000 (нижний предел по умолчанию установлен больше 0). Нажмите +Новый, чтобы добавить дополнительные пакеты. Необходимо указать верхний предел для последнего пакета, если вы не хотите взимать с разработчика фиксированную плату за неограниченное количество транзакций в последнем пакете. Примечание : Количество десятичных знаков, которые можно указать для тарифа, можно настроить с помощью API (а не пользовательского интерфейса). Подробнее см. раздел «Настройка количества десятичных знаков для тарифов тарифных планов» . Например, если в разделе «Размер пакета» вы указываете два пакета (от 0 до 1000 и от 1000 до 2000), вы можете ввести 50 для пакета от 0 до 1000 и 40 для пакета от 1000 до 2000. Если выбранная валюта — доллары США, цена первого пакета составит 50 долларов, а второго — 40 долларов. С разработчика взимается соответствующая цена пакета независимо от количества транзакций, используемых в пакете (то есть, с разработчика взимается цена пакета сразу после завершения первой транзакции в пакете). |
Если вы определили пользовательские атрибуты для своего API-продукта, вы можете настроить пользовательский параметр тарификации , чтобы взимать плату с разработчика приложения на основе этого атрибута в каждой транзакции. Например, если вы настроили тарифный план, в котором с разработчика взимается плата за каждую транзакцию, вы можете установить тариф для этого плана на основе пользовательского атрибута, такого как количество байтов, передаваемых на бэкэнд, которое может варьироваться в зависимости от транзакции.
В этом случае выберите «Использовать пользовательский параметр тарификации» и выберите пользовательский атрибут из раскрывающегося списка. Для получения дополнительной информации см. раздел «Настройка тарифного плана с пользовательскими атрибутами» .
Классический Edge (частное облако)
Для настройки тарифных планов с помощью классического пользовательского интерфейса Edge:
- Выполните следующие шаги, чтобы создать тарифный план .
- Выберите «Тарифный план» в раскрывающемся списке «Тип тарифного плана», чтобы настроить модель получения дохода .
- Если выбранный пакет API включает несколько продуктов API, выберите один из следующих вариантов:
Примечание : Если пакет API включает в себя только один продукт API, этот шаг можно пропустить.
- Планы для конкретных продуктов позволяют настраивать параметры тарифного плана для каждого API-продукта в отдельности.
- Универсальный план для всех продуктов позволяет настроить параметры тарифного плана для всех продуктов API.
- Нажмите на «Тарифный план» , чтобы просмотреть общий тарифный план или тарифный план для каждого конкретного API-продукта.
Примечание : При настройке тарифных планов для конкретных продуктов API вам потребуется настроить отдельный тарифный план для каждого продукта API.
Открывается окно прайс-листа.
- Создайте тарифный план «freemium» для API-продукта. Тарифный план «freemium» предлагает разработчикам бесплатное использование API-продукта в течение определенного периода времени или в зависимости от объема использования.
Введите следующую информацию:
Поле Описание Продукт с условно-бесплатной моделью распространения? Продолжительность бесплатного периода. Выберите один из следующих переключателей:
- По количеству. Бесплатный период рассчитывается исходя из количества, указанного в поле «Объем».
- По продолжительности. Период оплаты определяется временным интервалом, указанным в поле «Продолжительность бесплатной версии».
- Что наступит раньше. Бесплатный период заканчивается, когда достигается либо значение, указанное в поле «Объем», либо временной интервал, указанный в поле «Длительность бесплатной версии», в зависимости от того, что произойдет раньше.
- Нет. Это не бесплатный тарифный план с платными функциями. Это тариф по умолчанию.
Бесплатный том Объем транзакций (или объем, относящийся к пользовательскому атрибуту, зарегистрированному в политике регистрации транзакций), за которые с разработчиков не взимается плата. Объем измеряется для продукта API. Введите числовое значение объема, например, 5000. Это означает, что при запуске плана с разработчиков не взимается плата за первые 5000 транзакций (или за первые 5000 использований элемента, связанного с пользовательским атрибутом). Это поле доступно только в том случае, если в поле «Бесплатный продукт?» выбрано «По количеству» или «Что наступит раньше».
Продолжительность условно-бесплатной модели Интервал времени, в течение которого с разработчиков не взимается плата. Введите число и выберите период времени, например, 1 месяц. Это означает, что с разработчиков не будет взиматься плата в течение 1 месяца. Это поле становится доступным только в том случае, если в поле «Бесплатный продукт?» вы выберете «По продолжительности» или «Что наступит раньше».
- Выберите одну из следующих моделей зарядных устройств:
- Фиксированная ставка. В этой модели с застройщика взимается фиксированная плата за каждую транзакцию.
- Модель с ценообразованием по объему транзакций. В этой модели с разработчика взимается переменная ставка, зависящая от объема транзакций.
- Пакеты. В этой модели разработчику взимается фиксированная сумма (авансом) за каждый пакет транзакций. С разработчика взимается фиксированная сумма независимо от того, был ли пакет использован полностью или нет.
Для модели с фиксированной ставкой: введите следующую информацию в разделе «Цены» окна «Стандартный тарифный план»:
Поле Описание Оператор (или организация) Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.
Страна Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.
Единая ставка Стоимость каждой транзакции. Введите десятичное число (с четырьмя знаками после запятой).
Примечание : Количество десятичных знаков, которые можно указать для тарифа, можно настроить с помощью API (а не пользовательского интерфейса). Подробнее см. раздел «Настройка количества десятичных знаков для тарифов тарифных планов» .
Например, если вы введете 0,10, а валюта — доллары США, с разработчика будет взиматься 0,10 доллара за каждую транзакцию (или, если это зависит от пользовательского атрибута, такого как количество байтов, передаваемых в транзакции, с разработчика будет взиматься 0,10 доллара за передачу указанного количества байтов).
Для модели с диапазонами объемов: в окне «Стандартная таблица тарифов» отображаются дополнительные поля, которые используются для указания основы агрегирования и для задания «диапазонов объемов», то есть диапазонов объема транзакций, для которых можно применять разные тарифы.
Подобные планы обычно разрабатываются для того, чтобы стимулировать разработчиков к увеличению объемов производства за счет предоставления скидок на контракты с большими объемами.
В окне «Тарифная карта общего назначения» введите следующую информацию:
Поле Описание Основа агрегирования Период времени, за который суммируется объем транзакций (или объем, связанный с пользовательским атрибутом). Совокупный объем используется для определения диапазона объема и ставки, применяемой к каждой транзакции. Выберите количество месяцев (от 1 до 12 месяцев).
Подробную информацию о том, когда происходит сброс тарифных планов, см. в разделе «Когда начисляются регулярные платежи и происходит сброс тарифных планов?».
Диапазоны громкости Один или несколько диапазонов объема транзакций (или на основе атрибутов клиента) (каждый диапазон — это «диапазон объема»). Каждому диапазону объема можно присвоить ставку (эту ставку вы устанавливаете в поле «Диапазоны объема» раздела «Ценообразование»). Ставка применяется ко всем транзакциям в соответствующем диапазоне объема. Укажите верхний предел первого диапазона, например, до 1000 (нижний предел по умолчанию установлен на значение больше 0). Нажмите +, чтобы добавить второй диапазон, например, от 1000 до 2000. Нажмите +, чтобы добавить больше диапазонов. Вы можете оставить верхний предел последнего диапазона пустым, чтобы указать все транзакции, превышающие этот уровень.
Цены Оператор (или организация) Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.
Страна Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.
Валюта Базовая или учетная валюта, используемая вашей организацией. Это поле по умолчанию задается значением поля «Валюта» в профиле организации, но его можно изменить здесь.
Диапазоны громкости Стоимость для каждого диапазона громкости. Вы указываете стоимость для каждого диапазона громкости. Введите десятичное число для каждого диапазона (до четырех знаков после запятой).
Примечание : Количество десятичных знаков, которые можно указать для тарифного плана, можно настроить с помощью API (а не пользовательского интерфейса). Подробнее см. раздел «Настройка количества десятичных знаков для тарифных планов» .
Например, если в разделе «Диапазон объема» указаны два диапазона объема (>0-1000 и 1000 и выше), можно ввести 0,15 для диапазона >0-1000 и 0,10 для диапазона 1000 и выше. Если выбранная валюта — доллары США, курс для первых 1000 транзакций составит 0,15 доллара за каждую транзакцию, а для более чем 1000 транзакций — 0,10 доллара за каждую транзакцию.
Для пакетной модели: в окне «Универсальная таблица тарифов» отображаются дополнительные поля, которые используются для указания основы агрегирования (периода времени, в течение которого разработчик может использовать пакет транзакций) и для указания информации, связанной с пакетом, например, его размера.
В окне «Тарифная карта общего назначения» введите следующую информацию:
Поле Описание Основа агрегирования Период времени, в течение которого разработчик может использовать пакет транзакций (или использовать пакет на основе пользовательских атрибутов). Выберите количество месяцев (от 1 до 12 месяцев). По истечении этого периода действие плана истекает, и разработчику необходимо будет приобрести план (и пакеты) заново.
Подробную информацию о том, когда происходит сброс тарифных планов, см. в разделе «Когда начисляются регулярные платежи и происходит сброс тарифных планов?».
Размер комплекта Количество транзакций в пакете (или число, связанное с пользовательским атрибутом, например, общее количество байтов, переданных в пакете). Каждому пакету можно присвоить цену (вы устанавливаете эту цену в поле «Размер пакета» раздела «Цены»). Цена применяется ко всему пакету. Укажите верхний предел для первого пакета, например, до 1000 (нижний предел по умолчанию установлен больше 0). Нажмите +, чтобы добавить второй пакет, например, от 1000 до 2000. Нажмите +, чтобы добавить больше пакетов. Необходимо указать верхний предел для последнего пакета, если вы не хотите взимать с разработчика фиксированную плату за неограниченное количество транзакций в последнем пакете.
Цены Оператор (или организация) Название вашей организации. Это поле предварительно задается значением поля «Оператор» (или «Организация») в профиле организации.
Страна Страна деятельности вашей организации. Это поле предварительно задается значением поля «Страна» в профиле организации.
Валюта Базовая или учетная валюта, используемая вашей организацией. Это поле по умолчанию задается значением поля «Валюта» в профиле организации, но его можно изменить здесь.
Размер комплекта (цена) Цена за комплект. Вы указываете цену для каждого комплекта. Введите десятичное число (с четырьмя знаками после запятой).
Примечание : Вы можете настроить количество десятичных знаков, которые можно указать для тарифного плана, используя API (а не пользовательский интерфейс). Подробнее см. раздел «Настройка количества десятичных знаков для тарифных планов» .
Например, если в разделе «Размер пакета» указаны два пакета (от 0 до 1000 и от 1000 до 2000), вы можете ввести 50 для пакета «от 0 до 1000» и 40 для пакета «от 1000 до 2000». Если выбранная валюта — доллары США, цена первого пакета составит 50 долларов, а второго — 40 долларов. С разработчика взимается соответствующая цена пакета независимо от количества транзакций, используемых в пакете (то есть, с разработчика взимается цена пакета сразу после завершения первой транзакции в пакете).
- Нажмите «Применить и закрыть» , чтобы сохранить данные тарифного плана и вернуться в окно «Стандартный тарифный план».
- Для тарифных планов, специфичных для конкретных продуктов API, настройте параметры тарифного плана для дополнительных продуктов API по мере необходимости.
Настройка тарифного плана с использованием API
Настройте параметры тарифного плана с помощью API, как описано в следующих разделах.
Указание деталей тарифного плана с помощью API
Детали тарифного плана указываются при его создании. Эти детали задаются в свойстве ratePlanDetails в теле запроса к /organizations/{org_name}/monetization-packages/{package_id}/rate-plans . То, что вы указываете в свойстве ratePlanDetails , зависит от выбранной модели оплаты: фиксированная ставка, тариф с ограничением объема или пакетные предложения.
Указание модели фиксированной платы за обслуживание
Для внедрения модели фиксированной платы необходимо указать следующее в сведениях о тарифном плане:
- Параметр рейтинга, указывающий, основан ли тарифный план на количестве транзакций (
VOLUME) или на пользовательском атрибуте (например,MINT_CUSTOM_ATTRIBUTE_1). Значение по умолчанию —VOLUME. - Тип учета (
UNIT), указывающий на то, что тариф фиксирован за единицу (то есть, он не зависит от объема транзакций, как в случае с моделью оплаты по объему или пакетной моделью). - Срок оплаты (например, 30 дней).
- Идентификатор вашей организации.
- Базовая или учетная валюта, используемая вашей компанией.
- Тарифный план, содержащий подробную информацию о том, как рассчитывается ставка. Поскольку модель оплаты основана на фиксированной ставке, вы можете указать только один тарифный план.
В тарифном плане вы указываете:
- Тип тарифного плана (
RATECARD). - Тариф для данного плана. Например, если вы укажете 0,10, а валюта — доллары США, с разработчика будет взиматься 0,10 доллара за каждую транзакцию (или, если это зависит от пользовательского атрибута, такого как количество байтов, передаваемых в транзакции, с разработчика будет взиматься 0,10 доллара за передачу указанного количества байтов).
- Начальная единица применения ставки (
0). Это означает, что ставка применяется к каждой транзакции, начиная с первой транзакции.
Полный список параметров настройки сведений о тарифном плане см. в разделе «Настройки параметров тарифного плана».
Например, следующий код создает тарифный план с фиксированной моделью оплаты. Стоимость каждой транзакции устанавливается на уровне 0,10 доллара США. Оплата должна быть произведена в течение 30 дней. (Подробности, относящиеся к тарифному плану, выделены.)
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan",
"displayName" : "Flat rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"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
Указание модели зарядки с дифференцированным диапазоном объемов
В модели с диапазоном объемов вы указываете детали тарифного плана, которые включают один или несколько тарифов, каждый из которых применяется к «диапазону объемов», то есть диапазону объема транзакций (или диапазону, основанному на пользовательском атрибуте, таком как количество переданных байтов). Этот тип плана обычно настраивается для того, чтобы стимулировать разработчиков генерировать большие объемы, предлагая льготные тарифы для диапазонов больших объемов.
Помимо тарифов, указанных в описании тарифного плана, вы также можете указать следующее:
- Параметр тарифного плана, указывающий, основан ли он на количестве транзакций (
VOLUME) или на пользовательском атрибуте (например,CUSTOM_ATTRIBUTE_1). Значение по умолчанию —VOLUME. - Тип учета (
VOLUME), указывающий на то, что тариф основан на объеме транзакций (то есть, это не фиксированная ставка за транзакцию, как в модели фиксированной платы). - Срок оплаты (например, 30 дней).
- Идентификатор вашей организации.
- Базовая или учетная валюта, используемая вашей компанией.
- Продолжительность и тип продолжительности вместе определяют период времени, за который агрегируется объем транзакций (или объем, связанный с пользовательским атрибутом). Это также называется «основой агрегирования». Объем транзакций агрегируется за период агрегирования (например, 1 месяц) для определения применимого диапазона объема.
- Счетчики агрегации, используемые для определения применимого диапазона громкости.
Для каждого тарифного плана вы указываете:
- Тип тарифного плана (
RATECARD). - Тариф для данного плана. Например, если вы укажете 0,10, а валюта — доллары США, с разработчика будет взиматься 0,15 доллара за каждую транзакцию (или, если это зависит от пользовательского атрибута, такого как количество байтов, передаваемых в транзакции, с разработчика будет взиматься 0,15 доллара за передачу указанного количества байтов).
- Начальная и конечная единицы диапазона объема. Начальная единица определяет нижний предел диапазона объема, а конечная единица — верхний предел. Например, если вы укажете начальную единицу 0 и конечную единицу 1000, диапазон объема будет охватывать до 1000 транзакций в течение периода агрегирования. Если валюта — доллары США, период агрегирования составляет 1 месяц, а курс для первых 1000 транзакций составляет 0,15, то разработчику будет начислено 0,15 доллара за транзакцию, до 1000 транзакций в месяц.
Подробную информацию о том, когда происходит сброс тарифных планов, см. в разделе «Когда начисляются регулярные платежи и происходит сброс тарифных планов?».Если вы не указываете конечную единицу измерения для конечного диапазона объема, то ставка для этого диапазона применяется ко всем транзакциям после того, как количество транзакций превысит начальную единицу измерения для этого диапазона. Например, если начальная единица измерения для последнего диапазона равна 1000, и вы не указываете конечную единицу измерения для этого диапазона, то ставка для этого диапазона применяется ко всем транзакциям после 1000 транзакций в агрегированном периоде.
Полный список параметров настройки сведений о тарифном плане см. в разделе «Настройки параметров тарифного плана».
Например, следующий код создает тарифный план с моделью оплаты по объему транзакций. Тариф установлен на уровне 0,15 доллара США за первые 1000 транзакций и 0,10 доллара США за все транзакции свыше 1000. Основой агрегирования является 1 месяц. Оплата должна быть произведена в течение 30 дней. (Подробности тарифного плана выделены.)
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Volume banded rate card plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Volume banded rate card plan",
"displayName" : "Volume banded rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.15",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "1000"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"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
Указание модели комплексной зарядки
В модели пакетной оплаты разработчик платит (авансом) за «пакет» транзакций (или за пакет на основе пользовательского атрибута, такого как количество переданных байтов). Вы указываете ставку для каждого пакета и базу агрегирования, то есть период времени, в течение которого разработчик может использовать пакет.
Например, предположим, вы создали два пакета услуг, где размер первого пакета составляет от 1 до 1000 транзакций, а второго — от 1001 до 2000 транзакций. Стоимость составляет 50 долларов за первый пакет и 40 долларов за второй, а базовая сумма агрегации равна 1. Если разработчик приобретает тарифный план для первого пакета, он платит 50 долларов (авансом) за 1000 транзакций в месяц. С разработчика взимается установленная сумма независимо от того, использован ли пакет полностью. После окончания периода агрегации действие плана прекращается. Если разработчик хочет снова использовать пакет, он должен снова приобрести план (и пакет).
То, что вы указываете в деталях тарифного плана, по сути, совпадает с тем, что вы указываете в деталях тарифного плана для модели оплаты по объему. Различия заключаются в следующем:
- Каждый указанный вами тарифный план относится к пакету услуг (а не к диапазону объемов).
- Необходимо указать верхний предел для последнего пакета, если вы не хотите взимать с разработчика фиксированную сумму за неограниченное количество транзакций в последнем пакете.
Полный список параметров настройки сведений о тарифном плане см. в разделе «Настройки параметров тарифного плана».
Например, следующий код создает тарифный план с моделью пакетной оплаты. Стоимость первого пакета составляет 50 долларов (до 1000 транзакций), а второго пакета (более 1000 и до 2000 транзакций) — 40 долларов. Основой агрегирования является 1 месяц. Оплата должна быть произведена в течение 30 дней.
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Bundled rate plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Bundled rate plan",
"displayName" : "Bundled rate plan",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "true",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "STAIR_STEP",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "50",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "40",
"startUnit": "1000",
"endUnit": "2000"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"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
Указание бесплатного тарифного плана для отдельных продуктов с помощью API.
В тарифном плане вы можете настроить бесплатный тарифный план для отдельного продукта (а не для пакета API). Бесплатный тарифный план предлагает разработчикам бесплатное использование продукта API в течение определенного периода времени или в зависимости от объема использования.
При настройке бесплатного тарифного плана для API-продукта вы указываете в подробностях тарифного плана период, в течение которого разработчик может бесплатно использовать ресурсы, предоставляемые API-продуктом. Период может быть основан на одном из следующих вариантов:
- Продолжительность, то есть время между датой вступления в силу и датой окончания.
- Количественные показатели, такие как количество транзакций с использованием API-продукта или объем, относящийся к пользовательскому атрибуту, зарегистрированному в политике записи транзакций.
Если период бесплатного использования зависит от количества, укажите его в виде числа бесплатных единиц. Например, следующий код создает тарифный план с бесплатным использованием, основанным на объеме в 5000 единиц (характеристики, относящиеся к бесплатному использованию, выделены).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan with freemium period",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan with freemium period",
"displayName" : "Flat rate card plan with freemium period",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "myorg"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "false",
"ratePlanDetails": [
{
"currency": {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"id" : "usd"
},
"product" : {
"id" : "location",
"displayName":"Location"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "myorg"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"freemiumUnit": "5000",
"freemiumDuration": "0",
"freemiumDurationType": "DAY",
"ratingParameterUnit":"MB",
"customPaymentTerm": "false",
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"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