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

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

Введение

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

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

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

Изучение страницы с благодарностями

Перейдите на страницу «Авторы» и изучите её, как описано ниже.

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

1. Перейдите на страницу «Благодарности» .
2. Click + Credit .
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.

Например, следующий запрос предоставляет разработчику с адресом dev1@myorg.com кредит в размере 100 долларов США за расчетный месяц апрель 2018 года. Кредит применяется к пакету продуктов 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 кредитов доступны следующие параметры запроса: