Przyznawanie środków

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X.
informacje.

Wprowadzenie

Zarabianie daje Ci swobodę przyznawania środków deweloperowi.

W przypadku dewelopera przedpłaconych pojawia się jako spadek wykorzystania – powoduje to zwiększenie lub zmniejszenie salda z przedpłaty dewelopera. Podobne płatność za pomocą karty debetowej oznacza, że środki są pobierane z salda z przedpłaty dewelopera kupuje pakiet produktów API. Deweloper musi utrzymywać odpowiednią równowagę zakupów. Zobacz Jak obliczyć pozostałe saldo konta rozliczanego w systemie przedpłat?

W przypadku dewelopera płacącego po wykonaniu usługi środki są wyświetlane jako oddzielny wiersz na fakturze, zmniejszający opłatę na fakturze.

Informacje o stronie Środki

Uzyskaj dostęp do strony Środki w sposób opisany poniżej.

Edge

Aby uzyskać dostęp do strony Środki w interfejsie Edge:

  1. Zaloguj się na stronie apigee.com/edge.
  2. Kliknij Opublikuj > Zarabianie > Środki na pasku nawigacyjnym po lewej stronie.

Wyświetli się strona Środki.

Jak zaznaczono na ilustracji, strona Środki umożliwia:

  • wyświetlać podsumowanie informacji o wszystkich środkach, w tym nazwę odbiorcy, kwotę środków, datę i godzinę zastosowania środków; pakiety produktów i usługi API, do których mają zastosowanie środki, oraz wszelkie uwagi
  • Przyznanie środków
  • Przeszukaj listę środków

Classic Edge (Private Cloud)

Aby uzyskać dostęp do strony Środki w interfejsie Classic Edge:

  1. Zaloguj się w aplikacji http://ms-ip:9000, gdzie ms-ip to adres Adres IP lub nazwa DNS węzła serwera zarządzania.
  2. Wybierz Zarabianie > Raporty o przychodach na górnym pasku nawigacyjnym.

Na stronie Środki możesz:

  • wyświetlać podsumowanie informacji o wszystkich środkach, w tym nazwę odbiorcy, kwotę środków, datę i godzinę zastosowania środków; pakiety produktów i usługi API, do których mają zastosowanie środki, oraz wszelkie uwagi
  • Przyznanie środków
  • Przeszukaj listę środków

Przyznanie 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 środki zostały zastosowane. Wybierz miesiąc z listy.

    Deweloper

    Nazwa dewelopera lub firmy, której dotyczy kwota promocyjna. Wpisz nazwę w polu tekstowym. Podczas pisania pojawi się lista deweloperów/firm zawierających ten ciąg znaków. Kliknij na liście nazwę dewelopera lub firmy.

    Uwaga: po wybraniu dewelopera lub firmy wyświetlą się pozostałe pola. Jeśli wybierzesz firmę lub dewelopera, który nie zaakceptował abonamentu, nie będziesz mieć możliwości przyznania środków.

    Pakiet produktów

    Pakiet usług interfejsu API, do którego mają zastosowanie środki. Wybierz z listy dostępnych pakietów produktów API.

    Produkt

    Usługa API w wybranym pakiecie usług API, do którego mają zastosowanie środki. Wybierz Wszystkie produkty lub 1 usługa interfejsu API z listy.

    Waluta

    Waluta, w której przyznano środki. Waluta jest skonfigurowana dla planu stawek w pakiecie usług API, który dewelopera i nie można tego zmienić. Jeśli w planie stawek określono 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ć zero.

    Uwaga

    Opcjonalna uwaga z opisem przyczyny przyznania środków.

  4. Kliknij Zapisz środki.

Wystawianie punktów za pomocą interfejsu API

Korzystając z interfejsu API, przypisz deweloperowi środki w odniesieniu do całości pakietu produktów API lub przed użyciem określonego produktu API w pakiecie produktów 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ą informacje o pakiecie usług API i planie stawek, do których ma zastosowanie kredyt.

Przy wysyłaniu żądania musisz określić jako parametry zapytania:

  • Identyfikator dewelopera (adres e-mail), do którego przyznawane są środki.
  • Kwota kredytu.
  • Waluta, w której przyznano środki.
  • Notatka z opisem przyczyny obciążenia.

Opcjonalnie możesz określić te dodatkowe parametry zapytania:

  • Miesiąc rozliczeniowy, w którym przyznano środki. Wartość domyślna to bieżąca miesiąc.
  • Rok rozliczeniowy, do którego odnosi się kwota promocyjna. Domyślnie jest to bieżący rok.
  • Usługa API, do której mają zastosowanie środki. Jeśli nie określisz usługi API identyfikator, środki dotyczą wszystkich usług API w pakiecie produktów API.

Na przykład poniższe żądanie przyznało środki w wysokości 100 USD za miesiąc rozliczeniowy, który przypada kwiecień 2018 r. deweloperowi zidentyfikowanego jako dev1@myorg.com. Kredyt dotyczy Pakiet produktów interfejsu API payment i plan opłat payment_standard_plan:

Pełną listę parametrów zapytania znajdziesz w sekcji Parametry zapytania w interfejsie Credit API. który możesz określić we wniosku o zwrot ś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 zamieściliśmy 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 w interfejsie Credit API

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

Nazwa Opis Domyślny Wymagana?
billingMonth

Miesiąc rozliczeniowy, za który środki mają zastosowanie, np. KWIECIEŃ.

Nie dotyczy Nie
billingYear

Rok rozliczeniowy, za który środki mają zastosowanie, np. 2018 r.

Nie dotyczy Nie
currencyId

Waluta, w której przyznano środki. Waluta jest skonfigurowana dla planu stawek w pakiecie usług API, który dewelopera i nie można tego zmienić.

Nie dotyczy Tak
developerId

Nazwa dewelopera lub firmy, której dotyczy kwota promocyjna.

Nie dotyczy Tak
productId

Usługa API, do której mają zastosowanie środki. Jeśli nie określisz identyfikatora produktu, parametr kredyt dotyczy wszystkich produktów API w pakiecie produktów API.

Nie dotyczy Nie
transactionAmount

Kwota środków (w określonej walucie). Określ wartość dodatnią lub ujemną. Wartość nie może wynosić zero.

Nie dotyczy Tak
transactionNote

Uwaga: musisz podać powód zwrotu środków.

Nie dotyczy Tak