Выдача кредитов

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

Введение

Монетизация дает вам возможность выдавать кредит разработчику.

Для разработчика с предоплатой кредит отображается как сокращение использования — это увеличивает или уменьшает предоплаченный баланс разработчика в будущем. Как и при использовании дебетовой карты, средства снимаются с предоплаченного баланса разработчика, когда разработчик приобретает пакет продуктов API. Разработчик должен поддерживать достаточный баланс для покупок. См. раздел Как рассчитать оставшийся баланс предоплаченного счета?

Для разработчика с постоплатой кредит отображается отдельной строкой в ​​счете, уменьшая сумму в счете.

Изучение страницы «Кредиты»

Откройте и изучите страницу «Кредиты», как описано ниже.

Выдача кредита

1. Откройте страницу «Кредиты» .
2. Нажмите + Кредит .
3. Введите следующую информацию:

   Поле	Описание
   Платежный месяц	Расчетный месяц, в котором применяется кредит. Выберите месяц из списка.
   Разработчик	Название разработчика или компании, на которую распространяется кредит. Введите имя в текстовое поле. По мере ввода в раскрывающемся списке отображается список разработчиков/компаний, содержащих эту строку. Нажмите на имя разработчика или компании из раскрывающегося списка. Примечание . После выбора разработчика или компании отображаются остальные поля. Если вы выберете компанию или застройщика, который не принял тарифный план, вы не сможете оформить кредит.
   Пакет продуктов	Пакет продуктов API, к которому применяется кредит. Выберите из списка доступных пакетов продуктов API.
   Продукт	Продукт API в выбранном пакете продуктов API, к которому применяется кредит. Выберите «Все продукты» или один продукт API из списка.
   Валюта	Валюта, использованная для кредита. Валюта настроена для тарифного плана в пакете продуктов API, приобретенном разработчиком, и не может быть изменена. Если в тарифном плане определено несколько валют, вы можете выбрать одну из валют.
   Количество	Сумма кредита (в указанной валюте). Укажите положительное или отрицательное значение. Значение не может быть нулевым.
   Примечание	Необязательное примечание для описания причины кредита.

4. Нажмите «Сохранить кредит» .

Выдача кредитов с помощью API

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

Чтобы выдать кредит с помощью API, отправьте POST-запрос к /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions , где {package_id} и {rate-plan_id} определяют идентификацию пакета продуктов API и тарифного плана, к которому применяется кредит соответственно.

При отправке запроса в качестве параметров запроса необходимо указать:

• Идентификатор разработчика (адрес электронной почты), к которому применяется кредит.
• Сумма кредита.
• Валюта, использованная для кредита.
• Примечание с описанием причины кредита.

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

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

Например, следующий запрос выдает кредит в размере 100 долларов США за расчетный месяц в апреле 2018 года разработчику, указанному как dev1@myorg.com . Кредит распространяется на пакет продуктов API payment и тарифный план payment_standard_plan :

Полный список параметров запроса, которые можно указать в запросе на кредит, см. в разделе Параметры запроса для API кредитов .

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

Ниже приведен пример фрагмента ответа:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

Параметры запроса для API кредитов

Следующие параметры запроса доступны для использования с API кредитов: