Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
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, aggiungerne di nuove o eliminarne alcune (se non sono utilizzate da uno sviluppatore o da un piano tariffario).
Gestione delle valute supportate utilizzando l'interfaccia utente
Gestisci le valute supportate e imposta la valuta predefinita nella sezione Imposte e valute della pagina Profilo dell'organizzazione. Per maggiori dettagli, consulta Gestire 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 tramite l'API
Visualizza una singola valuta supportata dalla tua organizzazione o tutte le valute supportate.
Per visualizzare una singola valuta supportata dalla tua organizzazione, invia una richiesta GET a
/mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, dove
{supportedCurrency_id} è l'identificazione della valuta supportata da visualizzare. 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
}
Aggiunta delle valute supportate tramite l'API
Aggiungi le valute supportate inviando una richiesta POST a
/mint//organizations/{org_name}/supported-currencies. Per ogni valuta supportata aggiunta,
devi specificare le seguenti informazioni nel corpo della richiesta:
- Nome della valuta supportata. Il nome è il codice ISO 4217 della valuta, ad esempio USD per il dollaro statunitense.
- Nome visualizzato.
- Descrizione.
- Indica se la valuta è virtuale o meno.
- Stato della valuta, ovvero se è possibile utilizzare o meno la valuta.
- Organizzazione per la quale verrà aggiunta la valuta supportata.
Se vuoi, puoi impostare:
- Massimale di credito per una valuta supportata (solo per sviluppatori con pagamento posticipato).
- Ricarica minima per una valuta supportata (solo sviluppatori con pagamento anticipato).
Per ulteriori informazioni, consulta Proprietà di configurazione delle valute supportate.
Ad esempio, il codice seguente aggiunge una valuta supportata per un'organizzazione:
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
Impostazione della valuta predefinita utilizzando l'API
Imposta la valuta predefinita per l'organizzazione impostando il valore currency su un codice valuta ISO 4217 supportato quando modifichi il profilo dell'organizzazione, come descritto in Gestire il profilo dell'organizzazione utilizzando l'API.
Modificare una valuta supportata utilizzando l'API
Modifica una valuta supportata inviando una richiesta PUT a
/mint/organizations/{org_name}/{supportedCurrencyId}, dove
{supportedCurrency_id} è l'identificazione della valuta supportata da actualizare. Devi specificare nel corpo della richiesta le proprietà aggiornate nonché 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
evidenziate 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. Ad
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 limite di credito per la 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à si applica soltanto agli sviluppatori che hanno sottoscritto un pagamento anticipato. Importo minimo che gli sviluppatori possono aggiungere al saldo del proprio account prepagato nella valuta specificata. |
N/D | No |
| nome |
Il codice ISO 4217 per la valuta, 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ì |