Управление тарифными планами

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

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

Изучение страницы тарифных планов

Откройте страницу тарифных планов, как описано ниже.

Край

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

  1. Войдите на сайт apigee.com/edge .
  2. Выберите «Опубликовать» > «Монетизация» > «Тарифные планы» на левой панели навигации.

Откроется страница «Тарифные планы».

Как показано на рисунке, страница «Тарифные планы» позволяет:

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

Чтобы просмотреть тарифные планы с помощью пользовательского интерфейса Classic Edge, перейдите на страницу «Пакеты API»:

  1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. Выберите «Опубликовать» > «Пакеты» на верхней панели навигации.

На странице «Пакеты API» отображаются тарифные планы, определенные для каждого пакета.

Страница «Тарифные планы» позволяет:

Создание тарифного плана

Чтобы создать тарифный план:

  1. Откройте страницу тарифных планов .
  2. Нажмите +Тарифный план .
  3. Настройте следующие поля на верхней панели:
    Поле Описание По умолчанию Необходимый
    Название тарифного плана Название вашего тарифного плана.

    ПРИМЕЧАНИЕ . Имя должно быть уникальным в пределах пакета продуктов API. Два плана в одном пакете продуктов не могут иметь одинаковое имя.

    		 Н/Д Да
    Тип тарифного плана Тип тарифного плана. Выберите значение из раскрывающегося списка. Список действительных типов тарифных планов см. в разделе Поддерживаемые типы тарифных планов . Н/Д Да
    Пакет продуктов Пакет продуктов API. Выберите значение из раскрывающегося списка. Дополнительную информацию о пакетах продуктов API см. в разделе Управление пакетами продуктов API .

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

    		 Н/Д Да
    Аудитория Аудитория, которая может получить доступ к тарифному плану. Выберите одно из следующих значений из раскрывающегося списка:
    • Все – Все разработчики.
    • Разработчик — Разработчик или компания. Введите имя разработчика или компанию. По мере ввода в раскрывающемся списке отображается список разработчиков/компаний, содержащих эту строку. Нажмите на имя разработчика или компании из раскрывающегося списка.
    • Категория разработчика — Категория разработчика. Выберите категорию разработчика из раскрывающегося списка.

      Настройте категории разработчиков по мере необходимости, как описано в разделе «Управление категориями разработчиков» .

    		 Каждый Нет
    Дата начала Дата вступления тарифного плана в силу. Введите дату начала или выберите дату с помощью календаря. Сегодня Нет
    Дата окончания Дата окончания действия тарифного плана. Чтобы указать дату окончания, включите параметр «Есть дата окончания», переключите переключатель и введите дату окончания или выберите дату с помощью календаря.

    ПРИМЕЧАНИЕ . Тарифный план будет действовать до конца дня указанной даты. Например, если вы хотите истечь срок действия тарифного плана 1 декабря 2018 г., вам следует установить значение endDate на 2018-11-30. В этом случае срок действия тарифного плана истечет в конце дня 30 ноября 2018 года; все запросы 1 декабря 2018 года будут заблокированы.

    		 Никто Нет
    Виден порталам Укажите, является ли тарифный план публичным или частным. См. раздел Государственные и частные тарифные планы . Включено Нет
  4. Настройте комиссию для тарифного плана. См. Настройка комиссий для тарифного плана .
    ПРИМЕЧАНИЕ . Не применимо к настраиваемым планам уведомлений.
  5. Если вы выбираете пакет продуктов, который содержит более одного продукта API, установите следующие настройки в разделе «Специальный или общий тарифный план» :
    ПРИМЕЧАНИЕ . Этот шаг неприменим к настраиваемым планам уведомлений.
    Поле Описание По умолчанию
    Настраивайте каждый продукт индивидуально Флаг, указывающий, нужно ли настраивать индивидуальный тарифный план для каждого продукта API. Неполноценный
    Настройте бесплатное предложение каждого продукта индивидуально. Флаг, указывающий, следует ли настраивать план Freemium для каждого продукта API. Неполноценный
    Выберите продукт Если вы включите один или оба флага, вам необходимо выбрать каждый продукт отдельно из раскрывающегося списка и настроить детали его тарифного плана.

    ПРИМЕЧАНИЕ . Убедитесь, что вы настроили все продукты в комплекте продуктов.

    		 Н/Д
  6. Настройте детали тарифного плана в зависимости от выбранного типа тарифного плана:
  7. Нажмите один из следующих вариантов:
    Кнопка Описание
    Сохранить как черновик Сохраните тарифный план как черновик.

    Тарифный план не будет виден разработчикам приложений, пока вы его не опубликуете. Вы можете редактировать любое поле в проекте тарифного плана.

    Опубликовать новый план Опубликуйте план.

    ПРИМЕЧАНИЕ . После публикации тарифного плана вы можете изменить дату окончания только в том случае, если она еще не установлена. Вы не можете удалить тарифный план после его публикации, но можете прекратить действие тарифного плана и заменить его будущим тарифным планом, как описано в разделе Срок действия опубликованного тарифного плана .

  8. Прикрепите политику проверки лимитов монетизации к прокси-серверам API, связанным с продуктами API, включенными в тарифный план. Политика проверки ограничений монетизации устанавливает ограничения монетизации прокси-серверов API и гарантирует, что любые ошибки будут точно отражены в аналитических отчетах и ​​отчетах о монетизации. Дополнительную информацию см. в разделе Обеспечение ограничений монетизации для прокси-серверов API .

Редактирование тарифного плана

Вы можете редактировать все поля в проекте тарифного плана, кроме «Пакет продуктов», «Тип» и «Аудитория». После публикации тарифного плана вы можете редактировать дату окончания только в том случае, если дата окончания не указана.

Чтобы отредактировать тарифный план:

  1. Откройте страницу тарифных планов .
  2. Нажмите на строку тарифного плана, который вы хотите изменить.
    Отобразится панель тарифного плана.
  3. При необходимости отредактируйте поля тарифного плана.
    ПРИМЕЧАНИЕ . После публикации тарифного плана вы можете изменить дату окончания только в том случае, если она еще не установлена.
  4. Нажмите один из следующих вариантов:
    Кнопка Описание
    Обновить проект (проект тарифных планов) Сохраните тарифный план как черновик.

    Тарифный план не будет виден разработчикам приложений, пока вы его не опубликуете. Вы можете редактировать любое поле в проекте тарифного плана.
    Опубликовать черновик (проекты тарифных планов) Опубликуйте тарифный план.

    ПРИМЕЧАНИЕ . После публикации тарифного плана вы можете изменить дату окончания только в том случае, если она еще не установлена. Вы не можете удалить тарифный план после его публикации, но можете прекратить действие тарифного плана и заменить его будущим тарифным планом, как описано в разделе Срок действия опубликованного тарифного плана .
    Обновленная дата окончания (опубликованные тарифные планы) Установите дату окончания опубликованного плана.

    ПРИМЕЧАНИЕ . После того как для опубликованного тарифного плана установлена ​​дата окончания, его уже нельзя изменить.

Удаление проекта тарифного плана

Удалите проект тарифного плана, если он больше не нужен.

ПРИМЕЧАНИЕ. Вы не можете удалить опубликованный тарифный план.

Чтобы удалить черновой тарифный план:

  1. Откройте страницу тарифных планов .
  2. Наведите курсор на тарифный план, который вы хотите удалить, чтобы отобразить меню действий.
  3. Нажмите .
  4. Нажмите «Удалить» , чтобы подтвердить действие.

Управление тарифными планами с помощью API

В следующих разделах описывается, как управлять тарифными планами с помощью API.

Создание тарифных планов с помощью API

Чтобы создать тарифный план, отправьте POST-запрос к /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans , где {monetizationpackage_id} — это идентификатор пакета продуктов API, для которого вы создаете тарифный план ( идентификатор возвращается в ответе при создании пакета продукта API).

При создании тарифного плана в теле запроса необходимо указать:

  • Идентификатор организации
  • Идентификатор пакета продуктов API
  • Название тарифного плана
  • Описание тарифного плана
  • Область действия тарифного плана (применяется ли он ко всем разработчикам или только к определенному разработчику, компании или категории разработчиков)
  • Дата вступления в силу тарифного плана
  • Валюта тарифного плана
  • Опубликовать ли тарифный план
  • Является ли тарифный план публичным или частным

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

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

В следующих разделах описано, как создавать тарифные планы:

Создание стандартного тарифного плана с помощью API

Чтобы создать стандартный тарифный план, установите для атрибута type значение STANDARD , как показано в следующем примере. 

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Создание тарифного плана разработчика или компании с помощью API

Чтобы применить тарифный план к конкретному разработчику или компании, установите значение type Developer . Вам также необходимо указать разработчика или компанию в запросе, указав идентификатор, юридическое название и имя компании-разработчика.

Например, следующий отрывок описывает тарифный план для разработчика Dev Five : 

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Создание тарифного плана категории разработчика с помощью API

Чтобы применить тарифный план к категории разработчиков, установите значение type Developer_Category . Вам также необходимо указать в запросе категорию разработчика. Например: 

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Создание тарифного плана API для конкретного продукта с использованием API

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

Например, следующий пример создает план распределения доходов с двумя продуктами API:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Чтобы добавить продукт API в пакет продуктов API my-package , вам необходимо добавить сведения о тарифном плане для продукта API в текст запроса, как описано в разделе Добавление продукта API в пакет продуктов API с API для конкретного продукта. тарифные планы .

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Установка тарифного плана как публичного или частного с помощью API

При создании тарифного плана вы можете указать, является ли он публичным или частным, с помощью атрибута isPrivate в теле запроса. Если установлено значение true , тарифный план будет частным. Дополнительную информацию см. в разделе «Государственные и частные тарифные планы» .

Например, следующее создает частный тарифный план: 

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password