Przyznawanie środków

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

Zarabianie daje Ci elastyczność w przyznawaniu udziału w przychodach deweloperowi.

W przypadku dewelopera płacącego z góry środki pojawiają się jako spadek wykorzystania – zwiększa lub zmniejsza saldo przedpłaty dewelopera. Podobnie jak w przypadku karty debetowej, środki są pobierane z salda przedpłaconego dewelopera, gdy ten kupuje pakiet usług interfejsu API. Deweloper musi mieć odpowiednią ilość środków na zakupy. Zobacz Jak obliczyć pozostałą kwotę na koncie przedpłaconym?

W przypadku dewelopera korzystającego z abonamentu zwrot środków pojawi się w oddzielnym wierszu na fakturze, zmniejszając kwotę do zapłaty.

Poznawanie strony Środki

Otwórz stronę Środki, postępując zgodnie z instrukcjami poniżej.

Przyznanie kredytu

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

   Pole	Opis
   Miesiąc rozliczeniowy	Miesiąc rozliczeniowy, w którym obowiązuje rabat. Wybierz miesiąc z listy.
   Deweloper	nazwę dewelopera lub firmy, której dotyczy rabat; Wpisz nazwę w polu tekstowym. Podczas pisania w menu pojawi się lista deweloperów lub firm, które zawierają ten ciąg znaków. Kliknij nazwę dewelopera lub firmy na liście. Uwaga: po wybraniu dewelopera lub firmy wyświetlą się pozostałe pola. Jeśli wybierzesz firmę lub programistę, którzy nie zaakceptowali cennika, nie możesz przyznać środków.
   Pakiet produktów	Pakiet usług API, do którego mają zastosowanie środki. Wybierz z listy dostępne pakiety usług interfejsu API.
   Produkt	Usługa API w wybranym pakiecie usług API, do którego mają zastosowanie środki. Wybierz Wszystkie produkty lub pojedynczy produkt API z listy.
   Waluta	Waluta, w której przyznano środki. Waluta jest skonfigurowana dla abonamentu w pakiecie usług interfejsu API, który został zakupiony przez dewelopera, i nie można jej zmienić. Jeśli w planie stawek określono wiele walut, możesz wybrać jedną z nich.
   Kwota	Kwota środków (w wybranej walucie). Podaj wartość dodatnią lub ujemną. Wartość nie może wynosić 0.
   Uwaga	Opcjonalna notatka z opisem przyczyny przyznania kredytu.

4. Kliknij Zapisz kredyt.

Przyznawanie środków za pomocą interfejsu API

Korzystając z interfejsu API, wypłacać deweloperowi środki za pakiet produktów interfejsu API jako całości lub za użycie konkretnego produktu interfejsu API w pakiecie produktów interfejsu 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} definiują odpowiednio identyfikator pakietu usług API i abonamentu, do których ma zastosowanie kredyt.

Gdy wysyłasz żądanie, musisz podać te parametry zapytania:

• Identyfikator dewelopera (adres e-mail), do którego odnoszą się środki.
• Kwota zwrotu środków.
• Waluta, w której przyznano środki.
• Notatka z opisem przyczyny przyznania środków.

Opcjonalnie możesz podać te dodatkowe parametry zapytania:

• Miesiąc rozliczeniowy, w którym przyznano rabat. Domyślnie jest to bieżący miesiąc.
• Rok rozliczeniowy, do którego odnosi się kwota promocyjna. Domyślnie jest to bieżący rok.
• Produkt interfejsu API, do którego ma zastosowanie kredyt. Jeśli nie podasz identyfikatora produktu API, środki zostaną zastosowane do wszystkich usług API w pakiecie API.

Na przykład w ramach tej prośby zostanie przyznany zwrot w wysokości 100 USD za miesiąc rozliczeniowy kwiecień 2018 r. deweloperowi o identyfikatorze dev1@myorg.com. Środki dotyczą pakietu produktów API payment i abonamentu payment_standard_plan:

Pełną listę parametrów zapytania, które można określić w żądaniu środków, znajdziesz w artykule Parametry zapytania w interfejsie Credit 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

Oto 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 do interfejsu Credits API

Z interfejsem Credit API można używać tych parametrów zapytania:

Nazwa	Opis	Domyślny	Wymagany?
billingMonth	Miesiąc rozliczeniowy, w którym przyznano środki, np. KWIECIEŃ.	Nie dotyczy	Nie
billingYear	Rok rozliczeniowy, w którym środki są dostępne, np. 2018 r.	Nie dotyczy	Nie
currencyId	Waluta, w której przyznano środki. Waluta jest skonfigurowana dla abonamentu w pakiecie usług interfejsu API, który został zakupiony przez dewelopera, i nie można jej zmienić.	Nie dotyczy	Tak
developerId	nazwę dewelopera lub firmy, której dotyczy rabat;	Nie dotyczy	Tak
productId	Produkt interfejsu API, do którego ma zastosowanie kredyt. Jeśli nie podasz identyfikatora produktu, środki zostaną przypisane do wszystkich produktów interfejsu API w pakiecie produktów interfejsu API.	Nie dotyczy	Nie
transactionAmount	Kwota środków (w wybranej walucie). Podaj wartość dodatnią lub ujemną. Wartość nie może wynosić zero.	Nie dotyczy	Tak
transactionNote	Notatka z opisem przyczyny przyznania środków.	Nie dotyczy	Tak