Stai visualizzando la documentazione di Apigee Edge.
Consulta la
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, aggiungere valute supportate o eliminare valute supportate (se le valute non vengono utilizzate da uno sviluppatore o da un piano tariffario).
Gestire le valute supportate utilizzando l'interfaccia utente
Gestisci le valute supportate e imposta la valuta predefinita nella sezione Imposte e valuta della pagina Profilo dell'organizzazione. Per maggiori dettagli, vedi Gestire il profilo dell'organizzazione utilizzando l'interfaccia utente.
Gestire le valute supportate utilizzando l'API
Gestisci le valute supportate utilizzando l'API, come descritto nelle sezioni seguenti.
Visualizzare le valute supportate utilizzando l'API
Visualizza una singola valuta supportata dalla tua organizzazione o tutte le valute supportate 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} è 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 è riportato un esempio di 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
}Aggiungere valute supportate utilizzando l'API
Aggiungi valute supportate inviando una richiesta POST a
/mint//organizations/{org_name}/supported-currencies. Per ogni valuta supportata che aggiungi,
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.
- Se la valuta è virtuale o meno.
- Stato della valuta, ovvero se la valuta è disponibile per l'uso o meno.
- Organizzazione per la quale verrà aggiunta la valuta supportata.
In via facoltativa, puoi impostare:
- Limite di credito per una valuta supportata (solo per gli sviluppatori con pagamento posticipato).
- Ricarica minima per una valuta supportata (solo per gli sviluppatori con pagamento anticipato).
Per maggiori informazioni, vedi Proprietà di configurazione delle valute supportate.
Ad esempio, il seguente comando 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
Impostare la 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
aggiornare. Nel corpo della richiesta devi specificare le proprietà aggiornate
e l'ID della valuta supportata. 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
Eliminare 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 delle valute per l'API
La seguente tabella riassume le proprietà di configurazione che possono essere impostate utilizzando l'API.
| Nome | Descrizione | Predefinito | Obbligatorio? |
|---|---|---|---|
| creditLimit |
Questa proprietà si applica solo agli sviluppatori con pagamento posticipato. Il limite di credito per la valuta supportata. |
N/D | No |
| description |
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 solo agli sviluppatori con pagamento anticipato. Importo minimo che gli sviluppatori possono aggiungere al saldo dell'account prepagato nella valuta specificata. |
N/D | No |
| name |
Il codice ISO 4217 della valuta, ad esempio USD per il dollaro statunitense. |
N/D | Sì |
| organization |
L'organizzazione per la valuta supportata. |
N/D | Sì |
| status |
Lo stato della valuta supportata. I valori validi includono:
|
N/D | Sì |
| virtualCurrency |
Indica se la valuta supportata è una valuta virtuale. I valori validi includono:
|
N/D | Sì |