Przyznawanie środków

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

Wprowadzenie

Dzięki funkcji generowania przychodu możesz przyznawać deweloperom środki.

W przypadku dewelopera korzystającego z płatności z góry środki są widoczne jako zmniejszenie wykorzystania, co zwiększa lub zmniejsza saldo z przedpłaty dewelopera. Podobnie jak w przypadku korzystania z karty debetowej, środki są pobierane z salda z przedpłaty dewelopera, gdy kupuje on pakiet usług API. Deweloper musi utrzymywać odpowiednie saldo, aby móc dokonywać zakupów. Zobacz Jak obliczyć pozostałe saldo konta przedpłaconego?

W przypadku dewelopera korzystającego z płatności z dołu środki są widoczne jako osobna pozycja na fakturze, co zmniejsza kwotę obciążenia.

Przeglądanie strony Środki

Otwórz i przejrzyj stronę Środki, jak opisano poniżej.

Przyznawanie środków

1. Otwórz stronę Środki.
2. Kliknij + Środki.
3. Podaj te informacje:

   Pole	Opis
   Miesiąc rozliczeniowy	Miesiąc rozliczeniowy, w którym obowiązują środki. Wybierz miesiąc z listy.
   Deweloper	Nazwa dewelopera lub nazwa firmy, której dotyczą środki. Wpisz nazwę w polu tekstowym. Podczas pisania na liście rozwijanej będą się pojawiały nazwy deweloperów lub firm zawierające 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 dewelopera, który nie zaakceptował planu taryfowego, nie możesz przyznać środków.
   Pakiet usług	Pakiet usług API, którego dotyczą środki. Wybierz z listy dostępnych pakietów usług API.
   Usługa	Usługa API w wybranym pakiecie usług API, której dotyczą środki. Kliknij Wszystkie usługi lub wybierz jedną usługę API z listy.
   Waluta	Waluta używana do środków. Waluta jest skonfigurowana w planie taryfowym w pakiecie usług API, który kupił deweloper, i nie można jej zmienić. Jeśli w planie taryfowym zdefiniowano kilka walut, możesz wybrać jedną z nich.
   Kwota	Kwota środków (w określonej walucie). Podaj wartość dodatnią lub ujemną. Wartość nie może wynosić 0.
   Notatka	Opcjonalna notatka opisująca powód przyznania środków.

4. Kliknij Zapisz środki.

Przyznawanie środków za pomocą interfejsu API

Za pomocą interfejsu API możesz przyznać deweloperowi środki na cały pakiet usług API lub na korzystanie z konkretnej usługi API w pakiecie usług API.

Aby przyznać środki za pomocą interfejsu API, wyślij żądanie POST na adres /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 taryfowego, których dotyczą środki.

W żądaniu musisz podać te parametry zapytania:

• Identyfikator dewelopera (adres e-mail), którego dotyczą środki.
• Kwota środków.
• Waluta używana do środków.
• Notatka opisująca powód przyznania środków.

Opcjonalnie możesz podać te dodatkowe parametry zapytania:

• Miesiąc rozliczeniowy, którego dotyczą środki. Domyślnie jest to bieżący miesiąc.
• Rok rozliczeniowy, którego dotyczą środki. Domyślnie jest to bieżący rok.
• Usługa API, której dotyczą środki. Jeśli nie podasz identyfikatora usługi API, środki będą dotyczyć wszystkich usług API w pakiecie usług API.

Na przykład to żądanie przyznaje deweloperowi o identyfikatorze dev1@myorg.com środki w wysokości 100 USD na miesiąc rozliczeniowy kwiecień 2018 r. Środki dotyczą pakietu usług API payment i planu taryfowego payment_standard_plan:

Pełną listę parametrów zapytania, które możesz podać w żądaniu środków, znajdziesz w sekcji Parametry zapytania w interfejsie 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

Oto przykład fragmentu 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 API środków

W interfejsie API środków możesz używać tych parametrów zapytania: