Unterstützte Währungen verwalten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Einführung

Im Rahmen der Ersteinrichtung der Monetarisierung konfiguriert das Apigee Edge-Konfigurationsteam Währungen und die von Ihrer Organisation unterstützte Standardwährung.

Sie können die von Ihrer Organisation unterstützten Währungen aufrufen, unterstützte Währungen hinzufügen oder unterstützte Währungen löschen (wenn die Währungen nicht von einem Entwickler oder einem Preisplan verwendet werden).

Unterstützte Währungen über die Benutzeroberfläche verwalten

Verwalten Sie die unterstützten Währungen und legen Sie die Standardwährung im Bereich „Steuern und Währung“ der Seite „Organisationsprofil“ fest. Weitere Informationen finden Sie unter Organisationsprofil über die UI verwalten.

Unterstützte Währungen mithilfe der API verwalten

Verwalten Sie unterstützte Währungen mithilfe der API, wie in den folgenden Abschnitten beschrieben.

Unterstützte Währungen mithilfe der API ansehen

Sie können sich eine einzelne Währung ansehen, die von Ihrer Organisation unterstützt wird, oder alle von Ihrer Organisation unterstützten Währungen.

Wenn Sie eine bestimmte Währung aufrufen möchten, die von Ihrer Organisation unterstützt wird, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, wobei {supportedCurrency_id} die Identifizierung der unterstützten Währung ist, die aufgerufen werden soll. Beispiel:

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

Wenn Sie alle von Ihrer Organisation unterstützten Währungen ansehen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/supported-currencies. Beispiel:

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

Im Folgenden finden Sie ein Beispiel für die Antwort:

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

Unterstützte Währungen über die API hinzufügen

Fügen Sie unterstützte Währungen hinzu, indem Sie eine POST-Anfrage an /mint//organizations/{org_name}/supported-currencies senden. Geben Sie für jede unterstützte Währung, die Sie hinzufügen, die folgenden Informationen im Anfragetext an:

• Name der unterstützten Währung. Der Name ist der ISO-4217-Code für die Währung, z. B. USD für US-Dollar.
• Anzeigename
• Beschreibung:
• Gibt an, ob die Währung eine virtuelle Währung ist.
• Status der Währung, d. h., ob die Währung verwendet werden kann.
• Organisation, für die die unterstützte Währung hinzugefügt wird.

Optional können Sie Folgendes festlegen:

• Kreditlimit für eine unterstützte Währung (nur für Entwickler mit nachträglicher Zahlung)
• Minimaler Aufladebetrag in eine unterstützte Währung (nur für Entwickler mit Prepaid-Guthaben).

Weitere Informationen finden Sie unter Unterstützte Eigenschaften für die Währungskonfiguration.

Im folgenden Beispiel wird eine unterstützte Währung für eine Organisation hinzugefügt:

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

Standardwährung über die API festlegen

Legen Sie die Standardwährung für die Organisation fest, indem Sie den Wert currency beim Bearbeiten des Organisationsprofils auf einen unterstützten ISO 4217-Währungscode setzen, wie unter Organisationsprofil mit der API verwalten beschrieben.

Unterstützte Währung mithilfe der API bearbeiten

Eine unterstützte Währung bearbeiten, indem Sie eine PUT-Anfrage an /mint/organizations/{org_name}/{supportedCurrencyId} senden, wobei {supportedCurrency_id} die Identifizierung der unterstützten Währung ist, die aktualisiert werden soll. Sie müssen im Anfragetext die aktualisierten Attribute sowie die unterstützte Währungs-ID angeben. Mit dem folgenden API-Aufruf werden beispielsweise die Beschreibung und der Anzeigename für eine unterstützte Währung bearbeitet. Die aktualisierten Eigenschaften sind im Beispiel hervorgehoben:

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

Unterstützte Währung mithilfe der API löschen

Sie können eine unterstützte Währung löschen, indem Sie eine DELETE-Anfrage an /mint/organizations/{org_name}/supported-currencies/{currency_id} senden, wobei {currency_id} die Identifizierung der unterstützten Währung ist, die gelöscht werden soll. Beispiel:

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

Eigenschaften der Währungskonfiguration für die API

In der folgenden Tabelle sind die Konfigurationsattribute zusammengefasst, die über die API festgelegt werden können.

Name	Beschreibung	Standard	Erforderlich?
creditLimit	Diese Property gilt nur für Entwickler mit nachträglicher Zahlung. Das Kreditlimit für die unterstützte Währung.	–	Nein
Beschreibung	Eine Beschreibung der unterstützten Währung.	–	Ja
displayName	Der Name, der für die unterstützte Währung angezeigt werden soll.	–	Ja
minimumTopupAmount	Diese Property gilt nur für Prepaid-Entwickler. Mindestbetrag, den Entwickler in der angegebenen Währung zu ihrem Prepaidguthaben aufladen können.	–	Nein
name	Der ISO 4217-Code für die Währung, z. B. USD für US-Dollar.	–	Ja
Organisation	Die Organisation für die unterstützte Währung.	–	Ja
Status	Der Status der unterstützten Währung. Gültige Werte sind: ACTIVE: Es kann eine unterstützte Währung verwendet werden. INAKTIV: Die unterstützte Währung kann nicht verwendet werden.	–	Ja
virtualCurrency	Gibt an, ob die unterstützte Währung eine virtuelle Währung ist. Gültige Werte sind: true: Die unterstützte Währung ist virtuelle Währung. false: Die unterstützte Währung ist keine virtuelle Währung.	–	Ja