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

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

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

Прежде чем вы начнете использовать монетизацию в своей организации 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 указывает валюты, поддерживаемые вашей организацией, и устанавливает валюту по умолчанию.

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

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

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

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

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

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

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

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

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

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

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

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

Создавайте пакеты продуктов API, чтобы группировать продукты API.

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

Чтобы использовать API для управления пакетами продуктов API, см.:

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

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

Чтобы использовать API для настройки политики записи транзакций, см.:

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

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

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

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

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

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

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