Przenoszenie deweloperów do generowania przychodu

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Jeśli masz dotychczasowych deweloperów, których musisz przenieść do Monetization:

  1. Utwórz produkty API, pakiety API i plany taryfowe dla deweloperów, których przenosisz, jeśli jeszcze nie istnieją. Więcej informacji znajdziesz w tych artykułach:
  2. Opublikuj plany taryfowe zgodnie z opisem w artykule Publikowanie planów taryfowych.
  3. Dodaj nowych deweloperów do swojej organizacji zgodnie z opisem w artykule Rejestrowanie deweloperów aplikacji.
  4. Doładuj saldo z przedpłaty każdego dewelopera zgodnie z opisem w artykule Zarządzanie saldami kont przedpłaconych.
  5. Zaakceptuj plan taryfowy zgodnie z opisem w artykule Kupowanie planów taryfowych za pomocą interfejsu API.

    Uwaga: aby zrezygnować z opłat konfiguracyjnych, jeśli deweloper został już obciążony, ustaw parametr zapytania waivefees na true.

  6. Jeśli deweloper, którego przenosisz, ma istniejące transakcje, możesz ręcznie przenieść wykorzystanie transakcji za pomocą tego zasobu:
    /organizations/{org_name}/transactions, gdzie {org_name} to nazwa organizacji.

    Uwaga: jeśli deweloper nie ma istniejących transakcji, możesz pominąć ten krok.

    Zasób transactions wstawia pojedynczą transakcję, która odzwierciedla bieżące wykorzystanie transakcji, i aktualizuje wszystkie liczniki wewnętrzne, aby odzwierciedlały tę nową wartość.

    Jeśli na przykład deweloper przed migracją wykonał 1000 wywołań interfejsu API, aby zarejestrować bieżącą aktywność, możesz ustawić wykorzystanie transakcji na 1000, wywołując transactions i ustawiając właściwość batchSize na 1000 w treści żądania.

    W tabeli poniżej znajdziesz podsumowanie właściwości konfiguracyjnych, które możesz określić w treści żądania, aby ręcznie ustawić liczbę transakcji, ich wartości domyślne oraz informacje o tym, czy są one wymagane.

    Właściwość Opis Domyślny Wymagany?
    application

    Identyfikator aplikacji dewelopera.

    		 Nie dotyczy Tak
    batchSize

    Liczba transakcji, które chcesz przenieść.

    		 1 Nie
    custAttn

    Wartość atrybutu niestandardowego, który jest używany z parametrem batchSize do obliczania wykorzystania transakcji.

    Numer atrybutu niestandardowego w wiadomości musi być określony jako dodatnia liczba całkowita lub dziesiętna (do 4 miejsc po przecinku). Wartości ujemne są niedozwolone.

    Atrybut niestandardowy musi być zdefiniowany w:

    		 Nie dotyczy Tak
    product

    Identyfikator produktu API.

    		 Nie dotyczy Tak
    type

    Musi być ustawiony na CHARGE (wartość domyślna).

    		 CHARGE Nie

    Aby pominąć kroki weryfikacji i wymusić ustawienie liczby transakcji, ustaw parametr zapytania force na true (np. ?force=true). Domyślnie ?force=false i kroki weryfikacji są wykonywane. Jeśli na przykład deweloper korzystający z przedpłaty ma saldo zerowe, a aktywność na koncie jest zawieszona, w przypadku ustawienia ?force=false żądanie nie przejdzie weryfikacji.

    Na przykład to żądanie ustawia liczbę transakcji na 50 w przypadku określonej aplikacji i produktu API:

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize":50
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password

    To żądanie ustawia wykorzystanie transakcji na 12,5 w przypadku określonej aplikacji i produktu API. W żądaniu batchSize jest ustawione na 125, a wartość pierwszego atrybutu niestandardowego zdefiniowanego dla produktu API jest ustawiona na 0.1. Po pomnożeniu 125 * 0,1 daje 12,5.

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize": 125,
   "custAtt1" : 0.1
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password
  7. Jeśli deweloper nie został obciążony wymaganymi opłatami konfiguracyjnymi lub cyklicznymi, możesz ręcznie obciążyć go opłatą konfiguracyjną lub cykliczną za plan taryfowy, korzystając z tego zasobu:
    /organizations/{org_name}/transactions, gdzie {org_name} to nazwa organizacji.

    Uwaga: jeśli deweloper został już obciążony opłatami konfiguracyjnymi lub cyklicznymi, możesz pominąć ten krok. Wywołanie zasobu transactions nie wpłynie na opłaty konfiguracyjne ani cykliczne zdefiniowane w planie taryfowym.

    W tabeli poniżej znajdziesz podsumowanie właściwości konfiguracyjnych, które możesz określić w treści żądania, aby ręcznie obciążyć dewelopera opłatą konfiguracyjną lub cykliczną za plan taryfowy, ich wartości domyślne oraz informacje o tym, czy są one wymagane.

    Właściwość Opis Domyślny Wymagany?
    currency

    Waluta używana w planie taryfowym. Określ kod ISO 4217 waluty, np. usd w przypadku dolara amerykańskiego lub chf w przypadku franka szwajcarskiego.

    		 Nie dotyczy Tak
    developer

    Identyfikator dewelopera.

    		 Nie dotyczy Tak
    rate

    Opłata konfiguracyjna lub cykliczna, którą należy pobrać.

    		 Nie dotyczy Tak
    ratePlan

    Identyfikator planu taryfowego.

    		 Nie dotyczy Tak
    type

    Ustaw na SETUPFEES lub RECURRINGFEES.

    		 CHARGE Tak

    Aby pominąć kroki weryfikacji i wymusić pobranie opłaty, ustaw parametr zapytania force na true (np. ?force=true). Domyślnie ?force=false i kroki weryfikacji są wykonywane. Jeśli na przykład deweloper korzystający z przedpłaty ma saldo zerowe, a aktywność na koncie jest zawieszona, w przypadku ustawienia ?force=false żądanie nie przejdzie weryfikacji.

    Na przykład to żądanie pobiera opłatę konfiguracyjną w wysokości 10 USD od dewelopera, który subskrybuje plan taryfowy:

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev1@myorg.com"
   },
   "currency":{
     "id":"usd"
   },
   "ratePlan":{
     "id":"mypackage_rateplan1"
   },   
   "rate":10,
   "type":"SETUPFEES"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password