Миграция разработчиков на монетизацию

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

Если у вас есть существующие разработчики, которых вам нужно перевести на монетизацию:

  1. Создайте продукты API, пакеты API и тарифные планы для разработчиков, которых вы переносите, если они еще не существуют. Для получения дополнительной информации см.:
  2. Опубликуйте тарифные планы, как описано в разделе Публикация тарифных планов .
  3. Добавьте новых разработчиков в свою организацию, как описано в разделе Регистрация разработчиков приложений .
  4. Пополните предоплаченный баланс для каждого разработчика, как описано в разделе Управление предоплаченным балансом учетной записи .
  5. Примите тарифный план, как описано в разделе Приобретение тарифных планов с помощью API .

    Примечание . Чтобы отказаться от платы за установку, если с разработчика уже взималась плата, установите для параметра запроса waivefees значение true .

  6. Если у переносимого вами разработчика есть существующие транзакции, вы можете вручную передать использование транзакций, используя следующий ресурс:
    /organizations/{org_name}/transactions , где {org_name} — название организации.

    Примечание. Если у разработчика нет существующих транзакций, этот шаг можно пропустить.

    Ресурс transactions вставляет одну транзакцию, отражающую текущее использование транзакций, и обновляет все внутренние счетчики, чтобы отразить это новое значение.

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

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

    Свойство Описание По умолчанию Необходимый?
    application

    ID приложения разработчика.

    		 Н/Д Да
    batchSize

    Количество транзакций, которые вы хотите передать.

    		 1 Нет
    custAtt n

    Значение пользовательского атрибута, используемого с batchSize для расчета использования транзакций.

    Номер пользовательского атрибута в сообщении должен быть указан как положительное целое или десятичное (до четырех знаков после запятой) значение. Отрицательные значения не допускаются.

    Пользовательский атрибут должен быть определен в:

    		 Н/Д Да
    product

    ID продукта API.

    		 Н/Д Да
    type

    Должен быть установлен в CHARGE (по умолчанию).

    		 CHARGE Нет

    Чтобы пропустить этапы проверки и принудительно задать количество транзакций, установите для параметра force запроса значение true (например, ?force=true ). По умолчанию ?force=false и выполняются шаги проверки. Например, если у предоплаченного разработчика нулевой баланс и активность в учетной записи приостановлена, если ?force=false запрос не будет выполнен во время проверки.

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

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize":50
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password

    Следующий запрос устанавливает использование транзакций равным 12,5 для указанного приложения и продукта API. В запросе для параметра batchSize установлено значение 125 , а для первого пользовательского атрибута, определенного для продукта API, установлено значение 0.1 . При умножении 125 * 0,1 получается 12,5.

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize": 125,
   "custAtt1" : 0.1
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password
  7. Если с разработчика не взималась необходимая плата за установку или периодическая плата, вы можете вручную взимать плату за установку или периодическую плату за тарифный план, используя следующий ресурс:
    /organizations/{org_name}/transactions , где {org_name} — название организации.

    Примечание. Если с разработчика уже взималась плата за установку или регулярные платежи, этот шаг можно пропустить. Вызов ресурса transactions не повлияет на настройку или периодические сборы, определенные тарифным планом.

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

    Свойство Описание По умолчанию Необходимый?
    currency

    Валюта, используемая для тарифного плана. Укажите код ISO 4217 для валюты, например, usd для доллара США или chf для швейцарского франка.

    		 Н/Д Да
    developer

    ID разработчика.

    		 Н/Д Да
    rate

    Установка или регулярная плата за взимание.

    		 Н/Д Да
    ratePlan

    ID тарифного плана.

    		 Н/Д Да
    type

    Установите значение SETUPFEES или RECURRINGFEES .

    		 CHARGE Да

    Чтобы пропустить этапы проверки и принудительно взимать плату, установите для параметра force запроса значение true (например, ?force=true ). По умолчанию ?force=false и выполняются шаги проверки. Например, если у предоплаченного разработчика нулевой баланс и активность в учетной записи приостановлена, если ?force=false запрос не будет выполнен во время проверки.

    Например, следующий запрос взимает плату за установку в размере 10 долларов США с разработчика, подписавшегося на тарифный план:

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev1@myorg.com"
   },
   "currency":{
     "id":"usd"
   },
   "ratePlan":{
     "id":"mypackage_rateplan1"
   },   
   "rate":10,
   "type":"SETUPFEES"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password