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

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

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

  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