Zarządzaj obsługiwanymi walutami

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

Wprowadzenie

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

Możesz wyświetlać waluty obsługiwane przez Twoją organizację, dodawać obsługiwane waluty lub usuwać obsługiwane waluty (jeśli nie są one używane przez dewelopera ani w planie taryfowym).

Zarządzanie obsługiwanymi walutami za pomocą interfejsu

Zarządzaj obsługiwanymi walutami i ustaw domyślną walutę w sekcji Podatki i waluta sekcji na stronie Profil organizacji. Więcej informacji znajdziesz w artykule Zarządzanie profilem organizacji za pomocą interfejsu.

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

Zarządzaj obsługiwanymi walutami za pomocą interfejsu API, jak opisano w sekcjach poniżej.

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

Wyświetl poszczególne waluty obsługiwane przez Twoją organizację lub wszystkie waluty obsługiwane przez Twoją organizację.

Aby wyświetlić poszczególne waluty obsługiwane przez Twoją organizację, wyślij żądanie GET do /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, gdzie {supportedCurrency_id} to identyfikator obsługiwanej waluty, którą chcesz wyświetlić. 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ład 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
}

Dodawanie obsługiwanych walut za pomocą interfejsu API

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

• Nazwa obsługiwanej waluty. Nazwa to kod waluty w standardzie ISO 4217, np. USD w przypadku dolara amerykańskiego.
• Wyświetlana nazwa.
• Opis.
• Informacja, czy waluta jest walutą wirtualną.
• Stan waluty, czyli czy można jej używać.
• Organizacja, do której zostanie dodana obsługiwana waluta.

Opcjonalnie możesz ustawić:

• Limit środków dla obsługiwanej waluty (tylko deweloperzy korzystający z płatności odroczonych).
• Minimalne doładowanie dla obsługiwanej waluty (tylko deweloperzy korzystający z płatności z góry).

Więcej informacji znajdziesz w artykule Właściwości konfiguracji obsługiwanej waluty.

Na przykład poniższy kod dodaje obsługiwaną walutę do 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 domyślnej waluty za pomocą interfejsu API

Ustaw domyślną walutę organizacji, ustawiając wartość currency na obsługiwany kod waluty w standardzie ISO 4217 podczas edytowania profilu organizacji, jak opisano 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} to identyfikator obsługiwanej waluty, którą chcesz zaktualizować. W treści żądania musisz podać zaktualizowane właściwości oraz identyfikator obsługiwanej waluty. Na przykład następujące wywołanie interfejsu API edytuje opis i wyświetlaną nazwę obsługiwanej waluty (zaktualizowane właściwości są w przykładzie 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 za pomocą interfejsu API

Usuń obsługiwaną walutę, wysyłając żądanie DELETE do /mint/organizations/{org_name}/supported-currencies/{currency_id}, gdzie {currency_id} to identyfikator obsługiwanej waluty, którą chcesz usunąć. 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 w interfejsie API

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