Шаги по настройке монетизации

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

Прежде чем начать

Прежде чем начать использовать монетизацию в вашей организации Apigee, необходимо выполнить следующие предварительные задачи:

  • Создайте учетную запись Apigee Edge, как описано в разделе «Создание учетной записи Apigee Edge» .
  • Приобретите функцию монетизации. Изначально Edge не включает API монетизации и не интегрирует монетизацию в пользовательский интерфейс управления. Вам необходимо приобрести функцию монетизации, чтобы включить API монетизации и компоненты пользовательского интерфейса монетизации в Edge для вашей организации Apigee.

После приобретения монетизации вам необходимо выполнить следующие задачи:

Первоначальная настройка Apigee

Для завершения первоначальной настройки монетизации обратитесь к команде специалистов по настройке Apigee Edge. На основе ваших данных команда настроит следующее:

  • Независимо от того, является ли ваша организация телекоммуникационной компанией .
  • Какой тип оплаты вы хотите поддерживать для разработчиков, приобретающих ваши тарифные планы: предоплата, постоплата или оба варианта? См. раздел «Предоплата и постоплата» .
  • Если вам нужны подробные или сводные данные, извлеченные из процесса монетизации, и вы хотите перенести их в свою бухгалтерскую систему, а также необходим соответствующий формат данных.
  • Пользовательский адрес для ответа по электронной почте. Для уведомлений о монетизации, отправляемых компаниям и разработчикам, по умолчанию настроен адрес noreply@apigee.com. Вам необходимо запросить пользовательское имя и адрес для ответа для вашей организации.

Команда специалистов по настройке Apigee запускает скрипт для синхронизации монетизации с вашей организацией и любыми разработчиками, приложениями и API-продуктами, которые вы создали с помощью Apigee Edge. В будущем служба поддержки Apigee может запросить синхронизацию вашей организации, как описано в разделе «Синхронизация данных Apigee Edge с монетизацией» для получения более подробной информации. Не синхронизируйте данные монетизации без указаний Apigee.

Настройка монетизации

В таблице ниже приведено краткое описание шагов, необходимых для настройки монетизации вашей организации Apigee.
Шаг Описание
Отредактируйте профиль вашей организации В рамках первоначальной настройки монетизации команда специалистов по настройке Apigee Edge создает профиль вашей организации.

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

Управление поддерживаемыми валютами В рамках первоначальной настройки монетизации команда конфигурации Apigee Edge указывает валюты, поддерживаемые вашей организацией, и устанавливает валюту по умолчанию.

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

Примечание : Монетизация автоматически запускает ежедневное задание, которое получает обменный курс в долларах США для каждой поддерживаемой валюты. По умолчанию задание запускается каждый день в 1 секунду после полуночи. Подробности см. в разделе «Планирование заданий монетизации» .

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

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

Ввести ограничения на монетизацию. Прикрепите политику MonetizationLimitsCheck к API-прокси, чтобы обеспечить соблюдение лимитов монетизации.

В частности, действие политики активируется при следующих условиях:

  • Разработчик, обращающийся к монетизированному API, не зарегистрирован или не подписан на тарифный план.
  • Разработчик превысил объем транзакций по выбранному тарифному плану.
  • Достигнут баланс предоплаченного счета разработчика или лимит постоплатного кредита.
Настройте уведомления Настройте уведомления, чтобы оповещать разработчиков или поставщиков API о конкретном событии, например, о новом опубликованном тарифном плане.

Монетизируйте свои API

При монетизации API вы объединяете один или несколько продуктов API в пакет продуктов API и определяете соответствующий тарифный план.

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

В таблице ниже приведено краткое описание шагов, необходимых для монетизации ваших API.

Шаг Описание
Управление пакетами продуктов API

Создавайте пакеты продуктов API для группировки ваших продуктов API.

Примечание : В классическом пользовательском интерфейсе Edge и в API монетизации пакеты продуктов называются пакетами API.

Для управления пакетами продуктов API с помощью API см.:

Настройте политику записи транзакций.

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

Для настройки политики записи транзакций с помощью API см.:

Управление и публикация тарифных планов

Создайте тарифный план, чтобы определить подход к монетизации ваших API. Например, будете ли вы взимать фиксированную или переменную плату за использование вашего API.

Для управления тарифными планами с помощью API см.:

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

Управление монетизацией

После настройки монетизации и монетизации вашего API вы можете выполнить один или несколько шагов, описанных в следующей таблице:

Шаг Описание
Управление компаниями и разработчиками. Управление компаниями и разработчиками, использующими ваши API. Разработчик — это отдельная сущность, однозначно идентифицируемая по адресу электронной почты. Компания — это совокупность разработчиков, управляемых как единая сущность.
Создание отчетов Создавайте отчеты о балансе предоплаченных услуг, доходах и отклонениях. Для разработчиков, использующих предоплаченные услуги, вы можете сверять отчеты о балансе предоплаченных услуг с банковскими депозитами.
Внесите корректировки в выставленные счета. Например, внесите корректировки в счета, чтобы исправить расхождения в ваших записях.
Выпустить кредиты При необходимости начисляйте разработчикам кредиты. Для разработчиков с предоплатой кредит отображается как уменьшение объема использования, что увеличивает баланс предоплаты разработчика в будущем. Для разработчиков с постоплатой кредит отображается отдельной строкой в ​​счете-фактуре, уменьшая сумму платежа.
Управление балансом предоплаченных счетов Просматривайте текущий баланс предоплаченного счета и пополняйте предоплаченные счета или настройте автоматическое пополнение с помощью стороннего платежного провайдера.
Управляйте остатками на счетах постоплатных абонентов, используя кредитные лимиты. При добавлении поддерживаемой валюты для организации можно установить кредитный лимит для разработчика с постоплатной системой оплаты. Кредитный лимит применяется ко всем разработчикам с постоплатной системой оплаты в организации. Кроме того, можно установить кредитный лимит для отдельного разработчика с постоплатной системой оплаты. В этом случае кредитный лимит будет иметь приоритет над любым лимитом, установленным для валюты только для указанного разработчика.
Возврат средств после совершения покупки Возврат средств разработчикам по оплаченным транзакциям.
Планирование заданий по монетизации Монетизация предоставляет планировщик заданий и набор заданий, которые предварительно запланированы для выполнения в указанное время. Управление расписанием заданий монетизации осуществляется с помощью API.
Просмотр статуса транзакций С помощью API можно просмотреть статус транзакций, совершенных в указанный период времени.
Синхронизация данных Apigee Edge с монетизацией. Если Apigee даст соответствующее указание, выполните повторную синхронизацию данных с системой монетизации, чтобы убедиться в их корректности. Вы можете синхронизировать следующие элементы: организацию, API-продукты, разработчиков и приложения.
Удалите данные о монетизации из вашей организации. Возможно, вам потребуется удалить данные о монетизации из вашей организации, чтобы очистить тестовую организацию или удалить организацию.