Przyznawanie środków

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

Zarabianie daje Ci możliwość przyznawania środków dla deweloperów.

W przypadku deweloperów korzystających z przedpłat środki postrzegane są jako zmniejszenie wykorzystania. Powoduje to zwiększenie lub zmniejszenie salda przedpłaty dewelopera. Podobnie jak w przypadku karty debetowej, środki są pobierane z salda z przedpłaty dewelopera, gdy deweloper kupuje pakiet produktów API. Deweloper musi utrzymywać odpowiednią równowagę między zakupami a zakupami. Zobacz Jak obliczyć saldo pozostałego na koncie przedpłaty?

W przypadku deweloperów opłacanych po wykonaniu usługi środki są widoczne na fakturze jako osobny wiersz. Zmniejsza to opłata na fakturze.

Odkrywanie strony Środki

Aby uzyskać dostęp do strony Środki i ją przeglądać, jak opisano poniżej.

Przyznawanie kredytu

1. Otwórz stronę Środki.
2. Kliknij + Środki.
3. Wprowadź następujące informacje:

   Pole	Opis
   Miesiąc rozliczeniowy	Miesiąc rozliczeniowy, w którym przyznana jest kwota promocyjna. Wybierz miesiąc z listy.
   Deweloper	Nazwa dewelopera lub firmy, których dotyczy kwota promocyjna. Wpisz nazwę w polu tekstowym. Podczas pisania w menu wyświetli się lista deweloperów lub firm, które zawierają ten ciąg znaków. Kliknij nazwę dewelopera lub firmy na liście. Uwaga: gdy wybierzesz dewelopera lub firmę, wyświetlą się pozostałe pola. Jeśli wybierzesz firmę lub dewelopera, który nie zaakceptował planu taryfowego, nie możesz przyznać kredytu.
   Pakiet produktów	Pakiet produktów interfejsu API, których dotyczą środki. Wybierz z listy dostępnych pakietów produktów przy użyciu interfejsu API.
   Produkt	Usługa API w wybranym pakiecie usług API, którego dotyczą środki. Wybierz z listy Wszystkie usługi lub jedną usługę API.
   Waluta	Waluta użyta do uzyskania środków. Waluta jest skonfigurowana w planie stawek w pakiecie produktów API, który został kupiony przez dewelopera i nie można jej zmienić. Jeśli w planie stawek zdefiniowano wiele walut, możesz wybrać jedną z nich.
   Kwota	kwota środków (w określonej walucie). Określ wartość dodatnią lub ujemną. Wartość nie może wynosić 0.
   Uwaga	Opcjonalna uwaga opisująca powód przyznania kredytu.

4. Kliknij Zapisz środki.

Przyznawanie środków przy użyciu interfejsu API

Za pomocą interfejsu API możesz przyznać deweloperowi udział w całym pakiecie produktów API lub za korzystanie z konkretnej usługi w pakiecie API.

Aby przyznać środki za pomocą interfejsu API, wyślij żądanie POST do /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, gdzie {package_id} i {rate-plan_id} określają odpowiednio identyfikator pakietu usług API i planu stawek, do których zastosowanie mają środki.

Wysyłając żądanie, musisz określić jako parametry zapytania:

• Identyfikator dewelopera (adres e-mail), którego dotyczy kwota.
• kwotę kredytu.
• Waluta użyta do uzyskania środków.
• Notatka z wyjaśnieniem przyczyny zwrotu środków.

Opcjonalnie możesz podać te dodatkowe parametry zapytania:

• Miesiąc rozliczeniowy, do którego mają zastosowanie środki. Domyślnie jest to bieżący miesiąc.
• Rok rozliczeniowy, do którego mają zastosowanie środki. Domyślnie jest to bieżący rok.
• Usługa interfejsu API, której dotyczą środki. Jeśli nie określisz identyfikatora usługi, środki będą miały zastosowanie do wszystkich usług API w pakiecie usług API.

Na przykład to żądanie przyzna deweloperowi o nazwie dev1@myorg.com środki w wysokości 100 USD za miesiąc rozliczeniowy w kwietniu 2018 r. Środki mają zastosowanie do pakietu usług payment API i abonamentu ze stawkami payment_standard_plan:

Pełną listę parametrów zapytania, które możesz podać w prośbie o środki, znajdziesz w artykule Parametry zapytania dotyczące interfejsu API środków.

$ 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

Poniżej znajdziesz przykładowy fragment odpowiedzi:

{
  "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"
}

Parametry zapytania dla interfejsu API środków

W ramach interfejsu API środków dostępne są te parametry zapytania:

Nazwa	Opis	Domyślne	Wymagana?
billingMonth	Miesiąc rozliczeniowy, za który obowiązuje kwota promocyjna, np. KWIETNIA.	Nie dotyczy	Nie
billingYear	Rok rozliczeniowy, do którego ma zastosowanie kwota promocyjna, np. 2018.	Nie dotyczy	Nie
currencyId	Waluta użyta do uzyskania środków. Waluta jest skonfigurowana w planie stawek w pakiecie produktów API, który został kupiony przez dewelopera i nie można jej zmienić.	Nie dotyczy	Tak
developerId	Nazwa dewelopera lub firmy, których dotyczy kwota promocyjna.	Nie dotyczy	Tak
productId	Usługa interfejsu API, której dotyczą środki. Jeśli nie określisz identyfikatora produktu, środki będą stosowane do wszystkich usług API w pakiecie API.	Nie dotyczy	Nie
transactionAmount	kwota środków (w określonej walucie). Określ wartość dodatnią lub ujemną. Wartość nie może wynosić 0.	Nie dotyczy	Tak
transactionNote	Uwaga: powód zwrotu środków.	Nie dotyczy	Tak