Zarządzaj obsługiwanymi walutami

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

W ramach wstępnej konfiguracji zarabiania zespół konfiguracji Apigee Edge konfiguruje waluty oraz domyślną walutę obsługiwaną przez organizację.

Możesz wyświetlić waluty obsługiwane przez Twoją organizację, dodać obsługiwane waluty lub usuń obsługiwane waluty (jeśli nie są używane przez dewelopera lub w planie stawek).

Zarządzanie obsługiwanymi walutami za pomocą interfejsu użytkownika

Zarządzaj obsługiwanymi walutami i ustawiaj domyślną walutę w polach Podatek i Waluta na stronie Profil organizacji. Zobacz Zarządzanie profil organizacji za pomocą interfejsu.

Zarządzanie obsługiwanymi walutami przy użyciu interfejsu API

Zarządzaj obsługiwanymi walutami za pomocą interfejsu API zgodnie z opisem w następnych sekcjach.

Wyświetlanie obsługiwanych walut za pomocą interfejsu API

Wyświetlanie pojedynczej waluty obsługiwanej przez Twoją organizację lub wszystkich obsługiwanych przez nią walut.

Aby wyświetlić pojedynczą walutę obsługiwaną przez Twoją organizację, wyślij żądanie GET do /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, gdzie {supportedCurrency_id} wskazuje obsługiwaną walutę, która ma być . Na przykład:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

Aby wyświetlić wszystkie waluty obsługiwane przez Twoją organizację, wyślij żądanie GET do /mint/organizations/{org_name}/supported-currencies Na przykład:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

Oto przykład takiej odpowiedzi:

{
"supportedCurrency" : [ {
    "description" : "US Dollar",
    "displayName" : "US Dollar",
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    "status" : "ACTIVE",
    "virtualCurrency" : false
  }, {
    "creditLimit" : 5000.0000,
    "description" : "Euro",
    "displayName" : "Euro",
    "id" : "eur",
    "name" : "EUR",
    "organization" : {
      ...
    },
    "status" : "INACTIVE",
    "virtualCurrency" : false  
  } ],
  "totalRecords" : 2
}

Ustawianie domyślnej waluty za pomocą interfejsu API

Aby ustawić domyślną walutę organizacji, podczas edytowania profilu organizacji ustaw wartość parametru currency na obsługiwany kod waluty ISO 4217, zgodnie z opisem w artykule Zarządzanie profilem organizacji za pomocą interfejsu API.

Edytowanie obsługiwanej waluty za pomocą interfejsu API

Edytuj obsługiwaną walutę, wysyłając żądanie PUT do /mint/organizations/{org_name}/{supportedCurrencyId}, gdzie {supportedCurrency_id} wskazuje obsługiwaną walutę, która ma być Zaktualizowano. W treści żądania należy określić zaktualizowane właściwości i obsługiwany identyfikator waluty. Na przykład poniższe wywołanie interfejsu API zmienia opis i nazwę wyświetlaną obsługiwanej waluty (w przykładzie zaktualizowane właściwości są wyróżnione):

curl -H "Content-Type: application/json" -X PUT -d \
  '{
     "description": "United States Dollar",
     "displayName": "United States Dollar",
     "id": "usd",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status" : "ACTIVE",
     "virtualCurrency": "false"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
  -u email:password

Usuwanie obsługiwanej waluty przy użyciu interfejsu API

Aby usunąć obsługiwaną walutę, wyślij żądanie DELETE do adresu /mint/organizations/{org_name}/supported-currencies/{currency_id}, gdzie {currency_id} to identyfikator obsługiwanej waluty, która ma zostać usunięta. Przykład:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

Właściwości konfiguracji waluty na potrzeby interfejsu API

W tabeli poniżej znajdziesz podsumowanie właściwości konfiguracji, które można ustawić za pomocą interfejsu API.

Nazwa	Opis	Domyślny	Wymagany?
creditLimit	Ta usługa dotyczy tylko płatnych deweloperów. Limit kredytu w obsługiwanej walucie.	Nie dotyczy	Nie
opis	Opis obsługiwanej waluty.	Nie dotyczy	Tak
wyświetlanaNazwa	Nazwa do wyświetlania w przypadku obsługiwanej waluty.	Nie dotyczy	Tak
minimumTopupAmount	Ta usługa jest przeznaczona tylko dla deweloperów przedpłaconych. Minimalna kwota, jaką deweloperzy mogą dodać do salda konta z przedpłatą w wybranej walucie.	Nie dotyczy	Nie
nazwa	Kod ISO 4217 dla standardów np. PLN w przypadku złotego.	Nie dotyczy	Tak
organizacja	Organizacja obsługująca obsługiwaną walutę.	Nie dotyczy	Tak
status	Stan obsługiwanej waluty. Prawidłowe wartości: AKTYWNE: dostępna jest obsługiwana waluta. NIEAKTYWNE: nie możesz użyć obsługiwanej waluty.	Nie dotyczy	Tak
virtualCurrency	Wskazuje, czy obsługiwana waluta jest walutą wirtualną. Prawidłowe wartości: true: obsługiwana waluta to wirtualna waluta. false: Obsługiwana waluta nie jest walutą wirtualną.	Nie dotyczy	Tak