Как начислять бонусы

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

Введение

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

Для разработчика с предоплатой кредит будет отражен как уменьшение использования, что повлияет на сумму предоплаты. При покупке пакета продуктов API средства списываются с предоплаченного баланса разработчика, как при использовании дебетовой карты. Разработчик должен поддерживать достаточный баланс для покупок. Подробнее о том, как рассчитать оставшийся баланс аккаунта с предоплатой…

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

Страница Credits

Перейдите на страницу "Бонусы", как описано ниже.

Как выдать кредит

1. Перейдите на страницу "Титульные данные".
2. Нажмите + Кредитная карта.
3. Заполните следующие поля:

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

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

Как выставлять кредиты с помощью 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 в пакете.

Например, следующий запрос позволяет выставить кредит на сумму 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 кредитов

Для работы с Credits API доступны следующие параметры запроса: