Как настроить монетизацию

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

Подготовка

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

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

После покупки монетизации вам нужно будет выполнить следующие действия:

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

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

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

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

Как настроить монетизацию

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

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

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

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

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

Примечание. Условия использования находятся за пределами профиля организации. В профиле организации вы указываете местоположение (общедоступный URL) условий использования. Вы можете добавить несколько версий условий использования, чтобы отразить изменения, которые вносились с течением времени.
Принудительное применение ограничений монетизации Чтобы обеспечить соблюдение ограничений на монетизацию, прикрепите правило MonetizationLimitsCheck к прокси 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, разработчиков и приложения.
Как удалить данные о монетизации из организации Вы можете удалить данные о монетизации из организации, чтобы очистить тестовую организацию или удалить организацию.