Gestisci le valute supportate

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Introduzione

Nell'ambito della configurazione iniziale della monetizzazione, il team di configurazione di Apigee Edge configura le valute e quella predefinita supportata dalla tua organizzazione.

Puoi visualizzare le valute supportate dalla tua organizzazione, aggiungere valute supportate o eliminare quelle 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 nella sezione Imposta e valuta della pagina Profilo dell'organizzazione. Per maggiori dettagli, vedi 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 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 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 di valute supportate tramite l'API

Aggiungi le 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 degli Stati Uniti.
  • Nome visualizzato.
  • Descrizione.
  • Indica se la valuta è virtuale o meno.
  • Lo stato della valuta, ovvero se è disponibile o meno per l'uso.
  • Organizzazione per la quale verrà aggiunta la valuta supportata.

Facoltativamente, puoi impostare:

  • Limite di credito per una valuta supportata (solo sviluppatori con pagamento posticipato).
  • Ricarica minima per una valuta supportata (solo sviluppatori prepagati).

Per ulteriori informazioni, consulta Proprietà di configurazione della valuta supportate.

Ad esempio, nell'esempio seguente viene aggiunta 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 mediante 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 tramite 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} è l'identificazione della valuta supportata da aggiornare. Devi specificare nel corpo della richiesta le proprietà aggiornate e l'ID valuta supportato. Ad esempio, la seguente chiamata API modifica la descrizione e il nome visualizzato per 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 Campo obbligatorio?
creditLimit

Questa proprietà si applica solo agli sviluppatori con pagamento posticipato. Il massimale di credito per la valuta supportata.

N/A No
descrizione

Una descrizione della valuta supportata.

N/A
displayName

Il nome da visualizzare per la valuta supportata.

N/A
minimumTopupAmount

Questa proprietà riguarda soltanto gli sviluppatori con pagamento anticipato. Importo minimo che gli sviluppatori possono aggiungere al saldo prepagato del loro account nella valuta specificata.

N/A No
nome

Il codice ISO 4217 della valuta, ad esempio USD per il dollaro statunitense.

N/A
organizzazione

L'organizzazione della valuta supportata.

N/A
riconosciuto

Lo stato della valuta supportata. I valori validi sono:

  • ATTIVO: è possibile utilizzare la valuta supportata.
  • INATTIVO: la valuta supportata non è disponibile per l'uso.
N/A
virtualCurrency

Indica se la valuta supportata è virtuale. I valori validi sono:

  • true: la valuta supportata è una valuta virtuale.
  • false: la valuta supportata non è virtuale.
N/A