Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Wprowadzenie
Na karcie Generowanie przychodu możesz wprowadzać zmiany w szczegółach płatności. Możesz na przykład potrzebować zwiększenia lub zmniejszenia udziału w przychodach albo opłat w danym miesiącu rozliczeniowym ze względu na rozbieżności w danych.
Informacje o stronie Korekty płatności
Przejdź na stronę Wyrównania płatności w sposób opisany poniżej.
Edge
Aby uzyskać dostęp do strony Wyrównania płatności za pomocą interfejsu Edge:
- Zaloguj się na stronie apigee.com/edge.
- Kliknij Opublikuj > Zarabianie > Wyrównania płatności na pasku nawigacyjnym z lewej strony.
Wyświetli się strona Wyrównania płatności.
Jak zaznaczono na ilustracji, strona Korekta płatności umożliwia:
- Wyświetlanie bieżącej listy wyrównań płatności
- Dodawanie korekty płatności
- Edytowanie korekty płatności
- Przeszukiwanie listy wyrównań płatności
Classic Edge (Private Cloud)
Aby uzyskać dostęp do strony Wyrównania płatności w interfejsie Classic Edge:
- Zaloguj się w aplikacji
http://ms-ip:9000
, gdzie ms-ip to adres Adres IP lub nazwa DNS węzła serwera zarządzania. - Wybierz Zarabianie > Korekty na górnym pasku nawigacyjnym.
Strona Wyrównania płatności umożliwia:
- Wyświetlanie bieżącej listy wyrównań płatności
- Dodawanie korekty płatności
- Edytowanie wyrównania płatności
- Przeszukiwanie listy wyrównań płatności
Dodawanie korekty płatności
Aby dodać korektę płatności:
- Otwórz stronę Korekty płatności.
- Kliknij + Dostosowanie.
- Wprowadź następujące informacje:
Pole Opis Nazwa Nazwa opisowa, która będzie widoczna na dokumencie rozliczeniowym.
Korekta (%) Kwota korekty jako dodatnia lub ujemna wartość procentowa. A plus wartość procentowa dostosowuje udział w przychodach lub opłaty w transakcji o procent. Ujemna korekta zmniejsza udział w przychodach lub opłaty o tę wartość procentową. Wpisz dodatnią lub ujemną liczbę dziesiętną (ze znakiem plusa do dwóch miejsc po przecinku).
Miesiąc rozliczeniowy Miesiąc rozliczeniowy korekty. Wybierz miesiąc z listy.
Typ transakcji Typ transakcji, do której chcesz zastosować korektę. Wybierz z menu:
- Wszystkie transakcje
- Obciążenie (transakcje związane z ładowaniem modeli)
- Zakup (transakcje oparte na modelu dzielenia się przychodami)
- Zwrot środków (transakcje oparte na modelu dzielenia się przychodami)
Produkt Usługa API, do której chcesz zastosować korektę. Nie można zastosować pojedynczą korektę dla wielu usług API. Jeśli chcesz zastosować korektę do wielu produktów API, utwórz korektę dla każdego z nich. Wybierz usługę API z menu rozwijanego.
Deweloper Deweloper, do którego chcesz zastosować korektę. Możesz zastosować ustawienia wszystkich deweloperów (domyślnie) lub konkretnego dewelopera. Wybierz „Wszystkie” Programiści” lub nazwę konkretnego dewelopera.
- Kliknij Utwórz dostosowanie.
Edytowanie korekty płatności
Aby edytować korektę płatności:
- Otwórz stronę Korekty płatności.
- Najedź kursorem na dostosowanie płatności, które chcesz edytować, i kliknij w menu czynności.
- W razie potrzeby zaktualizuj wyrównanie płatności.
- Kliknij Zaktualizuj korektę.
Wprowadzanie korekt płatności przy użyciu interfejsu API
W sekcjach poniżej opisujemy, jak wprowadzać korekty płatności za pomocą interfejsu API.
Korekta płatności przy użyciu interfejsu API
Możesz zmienić szczegóły płatności, wysyłając żądanie POST na /organizations/{org_name}/billing-adjustments. W żądaniu możesz podać adres treść żądania:
- Nazwa korekty płatności.
- Procent korekty, czyli dodatnia lub ujemna wartość procentowa, odpowiednio zwiększa lub zmniejsza rachunek.
- Miesiąc rozliczeniowy.
- Rok rozliczeniowy.
- Organizacja, do której stosujemy korektę płatności.
Możesz też określić inne właściwości, na przykład:
- Typ transakcji, do której chcesz zastosować korektę (np. zakup transakcji).
- Deweloper, do którego chcesz zastosować korektę.
- Niezależnie od tego, czy chcesz zastosować korektę w przypadku deweloperów korzystających z przedpłaty, deweloperów abonamentowych czy i jednym, i drugim.
- Pakiet interfejsu API, do którego chcesz zastosować korektę.
- Usługa API, do której chcesz zastosować korektę.
Pełną listę znajdziesz w artykule Ustawienia konfiguracji korekty płatności. właściwości związanych z wyrównaniem płatności, które można określić w żądaniu korekty.
Jeśli właściwość opcjonalna nie zostanie określona, korekta dokumentu rozliczeniowego będzie obejmować wszystkie włącznie dla tej usługi. Jeśli np. nie określono typu transakcji, będzie dotyczyć wszystkich typów transakcji.
Poniższy przykład pokazuje korektę płatności za otwarty miesiąc rozliczeniowy, czerwiec 2013. powoduje zmniejszenie o 3% i jest stosowane do transakcji zakupu. usług płatniczych i programistów abonamentowych. Ponieważ właściwości służące do identyfikowania deweloper lub pakiet API nie został określony, korekta zostanie zastosowana do wszystkich deweloperów (którzy to programiści korzystający z usług płatnych) oraz jako usługa płatnicza we wszystkich pakietach API.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Purchase Adjustment Negative3", "adjustmentPercentageFactor": -3, "billingMonth": 6, "billingYear": 2017, "isPublished": false, "transactionType": "PURCHASE", "developerBillingType": "POSTPAID", "organization": { "id": "{org_name}" }, "product": { "id": "payment" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ -u email:password
Odpowiedź powinna wyglądać mniej więcej tak (widoczna jest tylko jej część):
{ "adjustmentPercentageFactor" : -3, "billingMonth" : 6, "billingYear" : 2017, "developerBillingType" : "POSTPAID", "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c", "isPublished" : false, "name" : "Purchase Adjustment Negative3", "organization" : { ... }, "product" : { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" }, "transactionType" : "PURCHASE" }
Wyświetlanie wyrównań płatności przy użyciu interfejsu API
Możesz wyświetlić konkretne lub wszystkie wyrównania płatności w organizacji.
Aby wyświetlić konkretne wyrównanie płatności, wyślij żądanie GET do
/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}
, gdzie
{billing_adjustment_id}
wskazuje konkretne wyrównanie płatności
(identyfikator jest zwracany w odpowiedzi podczas tworzenia korekty płatności). Na przykład:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \ -u email:password
Aby wyświetlić wszystkie wyrównania płatności w organizacji, wyślij żądanie GET do
/organizations/{org_name}/billing-adjustments
Na przykład:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ -u email:password
Odpowiedź powinna wyglądać mniej więcej tak (widoczna jest tylko jej część):
{ "billingAdjustment" : [ { "adjustmentPercentageFactor" : -3, "billingMonth" : 6, "billingYear" : 2017, "developerBillingType" : "POSTPAID", "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c", "isPublished" : false, "name" : "Purchase Adjustment Negative3", "organization" : { ... }, "product" : { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" }, "transactionType" : "PURCHASE" }, { "adjustmentPercentageFactor" : 5.0000, "billingMonth" : 5, "billingYear" : 2017, "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2", "isPublished" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" }, { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], "status" : "CREATED" }, "name" : "Test Package Adjustment", "organization" : { ... }, "product" : { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } } ], "totalRecords" : 2 }
Aktualizowanie korekty płatności przy użyciu interfejsu API
Możesz zaktualizować korektę płatności, wysyłając żądanie PUT do
/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}
, gdzie
{billing_adjustment_id}
wskazuje konkretne wyrównanie płatności.
Przy wykonywaniu aktualizacji musisz wskazać w treści żądania zaktualizowane właściwości i tag
identyfikator korekty płatności, która ma zostać zaktualizowana. Musisz również określić
obowiązkowe
właściwości korekty płatności, czyli właściwości nazwy, wartości procentowej korekty,
miesiąc rozliczeniowy, rok rozliczeniowy i organizację.
Na przykład to wywołanie interfejsu API aktualizuje wartość procentową i nazwę korekty (wartość zaktualizowane właściwości są wyróżnione w przykładzie):
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ", "adjustmentPercentageFactor": -5, "name" : "Purchase Adjustment Negative5", "billingMonth": 6, "billingYear": 2017, "isPublished": false, "transactionType": "PURCHASE", "developerBillingType": "POSTPAID", "organization": { "id": "{org_name}" }, "product": { "id": "payment" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \ -u email:password
Usuwanie korekty płatności przy użyciu interfejsu API
Możesz usunąć korektę płatności, wysyłając prośbę o USUNIĘCIE do
/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}
, gdzie
{billing_adjustment_id}
wskazuje korektę płatności, która ma zostać
Usunięto. Na przykład:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \ -u email:password
Ustawienia konfiguracji korekty płatności na potrzeby interfejsu API
Dostępne są te opcje konfiguracji korekty płatności:
Nazwa | Opis | Domyślny | Wymagana? |
---|---|---|---|
name |
Opisowa nazwa dostosowania płatności. |
Nie dotyczy | Tak |
adjustmentPercentageFactor |
Kwota korekty wyrażona jako dodatnia lub ujemna wartość procentowa. A plus wartość procentowa dostosowuje udział w przychodach lub opłaty w transakcji o wybraną wartość procentową. O ujemna wartość procentowa zmniejsza udział w przychodach lub opłaty w transakcji o procent. Wartości muszą mieścić się w zakresie od -100 do 999,9999. |
Nie dotyczy | Tak |
billingMonth |
Miesiąc rozliczeniowy, którego dotyczy korekta płatności, określony jako liczba całkowita. Na przykład: 11 za grudzień. |
Nie dotyczy | Tak |
billingYear |
Rok rozliczeniowy, do którego odnosi się korekta płatności, określony w tym formacie: RRRR. np. 2017 r. |
Nie dotyczy | Tak |
organization |
Organizacja, której dotyczy korekta płatności. |
Nie dotyczy | Tak |
isPublished |
Flaga określająca, czy korekta powinna zostać opublikowana. Wartość może być równa 1. spośród następujących:
|
Nie dotyczy | Nie |
transactionType |
Typ transakcji, których dotyczy korekta płatności. Możliwe typy to 1 spośród następujących:
|
Nie dotyczy | Nie |
developerBillingType |
Typ płatności dewelopera, którego dotyczy korekta płatności. Wartość może być jedną z tych wartości:
|
Nie dotyczy | Nie |
product |
Usługa API, w której przypadku ma zastosowanie korekta płatności. Jeśli nie określisz w tej usłudze, wyrównanie płatności dotyczy wszystkich usług API. |
Nie dotyczy | Nie |
monetizationPackage |
Pakiet interfejsu API, którego dotyczy korekta płatności. Jeśli nie określisz w tej usłudze, wyrównanie płatności dotyczy wszystkich pakietów interfejsów API. |
Nie dotyczy | Nie |
developer |
Deweloper, którego dotyczy korekta płatności. Jeśli nie określisz tego identyfikatora usługę, wyrównanie płatności dotyczy wszystkich deweloperów. |
Nie dotyczy | Nie |
Dalsze kroki
Zarabianie daje Ci swobodę przyznawania środków deweloperowi. Może być konieczne gdy deweloper nie jest zadowolony z usługi i prosi o częściowy lub pełny zwrot środków za używanie usługi. w danym okresie. Więcej informacji o przyznawaniu środków znajdziesz w sekcji Przypisywanie środków.