Sie lesen gerade die Dokumentation zu Apigee Edge.
Rufen Sie die
Dokumentation zu Apigee X auf. info
Einführung
Im Rahmen der Ersteinrichtung der Monetarisierung konfiguriert das Apigee Edge-Konfigurationsteam Währungen und die Standardwährung, die von Ihrer Organisation unterstützt wird.
Sie können die von Ihrer Organisation unterstützten Währungen ansehen, unterstützte Währungen hinzufügen oder löschen, wenn sie nicht von einem Entwickler oder einem Tarifpaket 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“ auf der Seite „Organisationsprofil“ fest. Weitere Informationen finden Sie unter Managing the organization profile using the UI.
Unterstützte Währungen über die API verwalten
Verwalten Sie unterstützte Währungen über die API, wie in den folgenden Abschnitten beschrieben.
Unterstützte Währungen über die API ansehen
Sie können eine einzelne Währung oder alle Währungen ansehen, die von Ihrer Organisation unterstützt werden.
Wenn Sie eine einzelne Währung ansehen 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 ID der unterstützten Währung ist, die Sie
ansehen möchten. 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 Währungen ansehen möchten, die von Ihrer Organisation unterstützt werden, 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
Senden Sie eine POST-Anfrage an
/mint//organizations/{org_name}/supported-currencies, um unterstützte Währungen hinzuzufügen. 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 es sich bei der Währung um eine virtuelle Währung handelt.
- 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 Postpaid-Entwickler).
- Mindestbetrag für eine Aufladung für eine unterstützte Währung (nur für Prepaid-Entwickler).
Weitere Informationen finden Sie unter Konfigurationsattribute für unterstützte Währungen.
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 currency Wert auf einen unterstützten ISO 4217 Währungscode
setzen, wenn Sie das Organisationsprofil bearbeiten, wie unter Organisationsprofil über die API verwalten beschrieben.
Unterstützte Währung über die API bearbeiten
Senden Sie eine PUT-Anfrage an
/mint/organizations/{org_name}/{supportedCurrencyId}, um eine unterstützte Währung zu bearbeiten. Dabei ist
{supportedCurrency_id} die ID der unterstützten Währung, die
aktualisiert werden soll. Geben Sie im Anfragetext die aktualisierten Attribute
sowie die ID der unterstützten Währung an. Mit dem folgenden API-Aufruf werden beispielsweise die Beschreibung und der Anzeigename für eine unterstützte Währung bearbeitet (die aktualisierten Attribute 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 über die API löschen
Senden Sie eine DELETE-Anfrage an
/mint/organizations/{org_name}/supported-currencies/{currency_id}, um eine unterstützte Währung zu löschen. Dabei ist
{currency_id} die ID der unterstützten Währung, 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
Konfigurationsattribute für Währungen 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 |
Dieses Attribut gilt nur für Postpaid-Entwickler. Das Kreditlimit für die unterstützte Währung. |
– | Nein |
| description |
Eine Beschreibung der unterstützten Währung. |
– | Ja |
| displayName |
Der Name, der für die unterstützte Währung angezeigt werden soll. |
– | Ja |
| minimumTopupAmount |
Dieses Attribut gilt nur für Prepaid-Entwickler. Der Mindestbetrag, den Entwickler ihrem Prepaid-Kontoguthaben in der angegebenen Währung hinzufügen können. |
– | Nein |
| name |
Der ISO 4217-Code für die Währung, z. B. USD für US-Dollar. |
– | Ja |
| organization |
Die Organisation für die unterstützte Währung. |
– | Ja |
| status |
Der Status der unterstützten Währung. Gültige Werte sind:
|
– | Ja |
| virtualCurrency |
Gibt an, ob es sich bei der unterstützten Währung um eine virtuelle Währung handelt. Gültige Werte sind:
|
– | Ja |