Zarządzaj obsługiwanymi walutami

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

Wstęp

Podczas wstępnej konfiguracji zarabiania zespół konfiguracji Apigee Edge konfiguruje waluty i domyślną walutę obsługiwaną przez Twoją organizację.

Możesz wyświetlić waluty obsługiwane w organizacji, dodać obsługiwane waluty lub usunąć te waluty (jeśli nie są one używane przez programistę lub abonament stawek).

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

Możesz zarządzać obsługiwanymi walutami i ustawić domyślną walutę w sekcji Podatek i waluta na stronie Profil organizacji. Więcej informacji znajdziesz w artykule Zarządzanie profilem organizacji za pomocą interfejsu użytkownika.

Zarządzanie obsługiwanymi walutami za pomocą interfejsu API

Zarządzaj obsługiwanymi walutami za pomocą interfejsu API w sposób opisany w poniższych sekcjach.

Wyświetlanie obsługiwanych walut przy użyciu interfejsu API

Wyświetl pojedynczą walutę obsługiwaną przez Twoją organizację lub wszystkie waluty obsługiwane przez Twoją organizację.

Aby wyświetlić pojedynczą walutę obsługiwaną przez Twoją organizację, wyślij do /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId} żądanie GET, gdzie {supportedCurrency_id} oznacza obsługiwaną walutę do wyświetlenia. 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

Poniżej znajdziesz przykładową odpowiedź:

{
"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
}

Dodawanie obsługiwanych walut przy użyciu interfejsu API

Dodaj obsługiwane waluty, wysyłając żądanie POST do /mint//organizations/{org_name}/supported-currencies. W przypadku każdej dodanej obsługiwanej waluty musisz podać w treści żądania te informacje:

• Nazwa obsługiwanej waluty. Nazwa to kod ISO 4217 waluty, np. PLN w przypadku złotego.
• Wyświetlana nazwa.
• Opis.
• Wskazuje, czy waluta jest walutą wirtualną.
• Stan waluty, czyli czy jest ona dostępna do użycia.
• Organizacja, dla której zostanie dodana obsługiwana waluta.

Opcjonalnie możesz ustawić:

• Limit kredytu w obsługiwanej walucie (dotyczy tylko deweloperów korzystających z płatności po wykonaniu usługi).
• Minimalne doładowanie w obsługiwanej walucie (tylko dla deweloperów korzystających z przedpłat).

Więcej informacji znajdziesz w artykule o obsługiwanych właściwościach konfiguracji waluty.

Na przykład poniższy kod dodaje obsługiwaną walutę dla organizacji:

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

Ustawianie waluty domyślnej przy użyciu interfejsu API

Aby ustawić domyślną walutę organizacji, podczas edytowania profilu organizacji ustaw wartość currency na obsługiwany kod waluty zgodny z normą ISO 4217. Więcej informacji znajdziesz w artykule Zarządzanie profilem organizacji przy użyciu interfejsu API.

Edytowanie obsługiwanej waluty za pomocą interfejsu API

Zmień obsługiwaną walutę, wysyłając żądanie PUT do /mint/organizations/{org_name}/{supportedCurrencyId}, gdzie {supportedCurrency_id} to identyfikacja obsługiwanej waluty, którą chcesz zaktualizować. Musisz podać w treści żądania zaktualizowane właściwości oraz obsługiwany identyfikator waluty. Na przykład to wywołanie interfejsu API zmienia opis i wyświetlaną nazwę obsługiwanej waluty (w tym przykładzie wyróżnione są zaktualizowane właściwości):

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

Usuń obsługiwaną walutę, wysyłając żądanie DELETE do /mint/organizations/{org_name}/supported-currencies/{currency_id}, gdzie {currency_id} oznacza obsługiwaną walutę do usunięcia. Na 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 dla 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ślne	Wymagana?
creditLimit	Ta usługa jest przeznaczona tylko dla deweloperów korzystających z abonamentów. Limit kredytu w obsługiwanej walucie.	Nie dotyczy	Nie
opis	Opis obsługiwanej waluty.	Nie dotyczy	Tak
displayName	Wyświetlana nazwa obsługiwanej waluty.	Nie dotyczy	Tak
minimumTopupAmount	Ta usługa jest przeznaczona tylko dla deweloperów korzystających z przedpłaty. Minimalna kwota, którą deweloperzy mogą dodać do salda konta przedpłaconego w określonej walucie.	Nie dotyczy	Nie
nazwa	Kod ISO 4217 waluty, np. PLN w przypadku złotego.	Nie dotyczy	Tak
organizacja	Organizacja korzystająca z obsługiwanej waluty.	Nie dotyczy	Tak
status	Stan obsługiwanej waluty. Prawidłowe wartości to m.in.: AKTYWNE: obsługiwana waluta jest dostępna. NIEAKTYWNA: obsługiwana waluta jest niedostępna.	Nie dotyczy	Tak
virtualCurrency	Wskazuje, czy obsługiwaną walutą jest waluta wirtualna. Prawidłowe wartości to m.in.: true: obsługiwaną walutą jest waluta wirtualna. false: obsługiwana waluta nie jest walutą wirtualną.	Nie dotyczy	Tak