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

Вы просматриваете документацию 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

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

    		 Н/Д Да
    batchSize

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

    		 1 Нет
    custAtt n

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

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

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

    		 Н/Д Да
    product

    Идентификатор продукта 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

    Идентификатор разработчика.

    		 Н/Д Да
    rate

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

    		 Н/Д Да
    ratePlan

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

    		 Н/Д Да
    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