Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione
Documentazione di Apigee X. Informazioni
Introduzione
Nell'ambito della configurazione iniziale della monetizzazione, il team di configurazione di Apigee Edge configura le valute e la valuta predefinita supportata dalla tua organizzazione.
Puoi visualizzare le valute supportate dalla tua organizzazione, aggiungere quelle supportate o eliminare le valute supportate (se non sono utilizzate da uno sviluppatore o da un piano tariffario).
Gestione delle valute supportate tramite l'interfaccia utente
Gestisci le valute supportate e imposta la valuta predefinita nel campo Imposte e valuta della pagina Profilo dell'organizzazione. Consulta la sezione Gestione il profilo dell'organizzazione utilizzando l'interfaccia utente.
Gestione delle valute supportate tramite l'API
Gestisci le valute supportate utilizzando l'API, come descritto nelle sezioni seguenti.
Visualizzazione delle valute supportate utilizzando l'API
Visualizzare una singola valuta supportata dalla tua organizzazione o da tutte le valute supportati dalla tua organizzazione.
Per visualizzare una singola valuta supportata dalla tua organizzazione, invia una richiesta GET a
/mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}
, dove
{supportedCurrency_id}
indica l'identificazione della valuta supportata
visualizzato. Ad esempio:
curl -X GET -H "Accept: application/json" \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \ -u email:password
Per visualizzare tutte le valute supportate dalla tua organizzazione, invia una richiesta GET a
/mint/organizations/{org_name}/supported-currencies
. Ad esempio:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \ -H "Accept: application/json" \ -u email:password
Di seguito viene fornito un esempio della risposta:
{ "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 }
Impostare la valuta predefinita utilizzando l'API
Imposta la valuta predefinita per l'organizzazione impostando il valore currency
su una valuta ISO 4217 supportata
codice quando modifichi il profilo dell'organizzazione, come descritto in Gestione dell'organizzazione
profilo usando l'API.
Modifica di una valuta supportata utilizzando l'API
Modifica una valuta supportata inviando una richiesta PUT a
/mint/organizations/{org_name}/{supportedCurrencyId}
, dove
{supportedCurrency_id}
indica l'identificazione della valuta supportata
aggiornato. Devi specificare le proprietà aggiornate nel corpo della richiesta
e l'ID valuta supportato. Ad esempio, la seguente chiamata API
modifica la descrizione e il nome visualizzato di una valuta supportata (le proprietà aggiornate sono
evidenziato nell'esempio):
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
Eliminazione di una valuta supportata utilizzando l'API
Elimina una valuta supportata inviando una richiesta DELETE a
/mint/organizations/{org_name}/supported-currencies/{currency_id}
, dove
{currency_id}
è l'identificazione della valuta supportata da eliminare. Per
esempio:
curl -X DELETE -H "Accept: application/json" \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \ -u email:password
Proprietà di configurazione della valuta per l'API
La tabella seguente riassume le proprietà di configurazione che possono essere impostate utilizzando l'API.
Nome | Descrizione | Predefinito | Obbligatorio? |
---|---|---|---|
creditLimit |
Questa proprietà è valida solo per gli sviluppatori con pagamento posticipato. Il massimale di credito per non è una valuta supportata. |
N/D | No |
descrizione |
Una descrizione della valuta supportata. |
N/D | Sì |
displayName |
Il nome da visualizzare per la valuta supportata. |
N/D | Sì |
minimumTopupAmount |
Questa proprietà è valida solo per gli sviluppatori che hanno scelto il pagamento anticipato. Importo minimo che gli sviluppatori possono aggiungere al saldo prepagato del loro account nella valuta specificata. |
N/D | No |
nome |
Il codice ISO 4217 per ad esempio USD per il dollaro statunitense. |
N/D | Sì |
organizzazione |
L'organizzazione per la valuta supportata. |
N/D | Sì |
stato |
Lo stato della valuta supportata. I valori validi sono:
|
N/D | Sì |
virtualCurrency |
Indica se la valuta supportata è una valuta virtuale. I valori validi sono:
|
N/D | Sì |