Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Einführung
Im Rahmen der Ersteinrichtung der Monetarisierung konfiguriert das Apigee Edge-Konfigurationsteam die Währungen und die von Ihrer Organisation unterstützte Standardwährung.
Sie können sich die von Ihrer Organisation unterstützten Währungen ansehen, unterstützte Währungen hinzufügen oder unterstützte Währungen löschen, wenn sie von keinem Entwickler oder Tarifplan verwendet werden.
Unterstützte Währungen über die Benutzeroberfläche verwalten
Sie können die unterstützten Währungen verwalten und die Standardwährung im Abschnitt „Steuern und Währungen“ auf der Seite „Organisationsprofil“ festlegen. Weitere Informationen finden Sie unter Organisationsprofil über die Benutzeroberfläche verwalten.
Unterstützte Währungen mit der API verwalten
Sie können unterstützte Währungen mithilfe der API wie in den folgenden Abschnitten beschrieben verwalten.
Unterstützte Währungen über die API ansehen
Sie können sich eine einzelne von Ihrer Organisation unterstützte Währung oder alle von Ihrer Organisation unterstützten Währungen ansehen.
Wenn Sie eine einzelne Währung abrufen 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 angezeigt 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 aufrufen 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 hinzugefügte unterstützte Währung 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.
- Der Status der Währung, d. h., ob die Währung verwendet werden kann oder nicht.
- Die Organisation, der 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)
- Mindestaufstockung für eine unterstützte Währung (nur für Prepaid-Entwickler)
Weitere Informationen finden Sie unter Unterstützte Konfigurationseigenschaften für Währungen.
Im folgenden Beispiel wird beispielsweise 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 mithilfe der API festlegen
Legen Sie die Standardwährung für die Organisation fest. Legen Sie dazu beim Bearbeiten des Organisationsprofils den Wert currency
auf einen unterstützten Währungscode nach ISO 4217 fest, wie unter Organisationsprofil mithilfe der API verwalten beschrieben.
Unterstützte Währung mit der API bearbeiten
Bearbeiten Sie eine unterstützte Währung, indem Sie eine PUT-Anfrage an /mint/organizations/{org_name}/{supportedCurrencyId}
senden. Dabei ist {supportedCurrency_id}
die Kennung der zu aktualisierenden unterstützten Währung. Sie müssen im Anfragetext die aktualisierten Properties 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 Properties 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 mit der 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 Kennung der zu löschenden unterstützten Währung. Beispiel:
curl -X DELETE -H "Accept: application/json" \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \ -u email:password
Währungskonfigurationseigenschaften für die API
In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die über die API festgelegt werden können.
Name | Beschreibung | Standard | Erforderlich? |
---|---|---|---|
creditLimit |
Diese Property gilt nur für Entwickler mit Postpaid-Abo. 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 Entwickler mit Vorauszahlung. Mindestbetrag, den Entwickler in der angegebenen Währung zu ihrem Prepaidguthaben hinzufügen 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:
|
– | Ja |
virtualCurrency |
Gibt an, ob die unterstützte Währung eine virtuelle Währung ist. Gültige Werte sind:
|
– | Ja |