Gérer les devises acceptées

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Introduction

Lors de la configuration initiale de la monétisation, l'équipe de configuration d'Apigee Edge configure les devises et la devise par défaut prise en charge par votre organisation.

Vous pouvez afficher les devises acceptées par votre organisation, en ajouter ou en supprimer (si elles ne sont pas utilisées par un développeur ou un forfait).

Gérer les devises prises en charge à l'aide de l'UI

Gérez les devises acceptées et définissez la devise par défaut dans la section "Taxes et devises" de la page "Profil de l'organisation". Voir la section Gestion le profil de l'organisation à l'aide de l'UI.

Gérer les devises acceptées à l'aide de l'API

Gérez les devises acceptées à l'aide de l'API, comme décrit dans les sections suivantes.

Afficher les devises acceptées à l'aide de l'API

Afficher une devise spécifique acceptée par votre organisation ou toutes les devises par votre organisation.

Pour afficher une devise spécifique prise en charge par votre organisation, envoyez une requête GET à /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, où {supportedCurrency_id} correspond à l'identification de la devise prise en charge à afficher. Exemple :

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

Pour afficher toutes les devises acceptées par votre organisation, envoyez une requête GET à /mint/organizations/{org_name}/supported-currencies. Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

Voici un exemple de réponse :

{
"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
}

Définir la devise par défaut à l'aide de l'API

Définissez la devise par défaut de l'organisation en définissant la valeur currency sur une devise ISO 4217 compatible. lorsque vous modifiez le profil de l'organisation, comme décrit dans la section Gérer l'organisation profil à l'aide de l'API.

Modifier une devise acceptée à l'aide de l'API

Modifiez une devise acceptée en envoyant une requête PUT à /mint/organizations/{org_name}/{supportedCurrencyId}, où {supportedCurrency_id} correspond à l'identification de la devise acceptée à mettre à jour. Vous devez spécifier dans le corps de la requête les propriétés mises à jour ainsi que l'identifiant de la devise acceptée. Par exemple, l'appel d'API suivant modifie la description et le nom à afficher pour une devise prise en charge (les propriétés mises à jour sont mis en évidence dans l'exemple):

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

Supprimer une devise acceptée à l'aide de l'API

Supprimez une devise acceptée en envoyant une requête DELETE à /mint/organizations/{org_name}/supported-currencies/{currency_id}, où {currency_id} correspond à l'identification de la devise acceptée à supprimer. Exemple :

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

Propriétés de configuration de la devise pour l'API

Le tableau suivant récapitule les propriétés de configuration pouvant être définies à l'aide de l'API.

Nom	Description	Par défaut	Obligatoire ?
creditLimit	Cette propriété ne s'applique qu'aux développeurs utilisant un forfait postpayé. Limite de crédit pour la devise acceptée.	N/A	Non
description	Description de la devise acceptée.	N/A	Oui
displayName	Nom à afficher pour la devise acceptée.	N/A	Oui
minimumTopupAmount	Cette propriété ne s'applique qu'aux développeurs en prépaiement. Montant minimal que les développeurs peuvent ajouter à la réserve prépayée de leur compte dans la devise spécifiée.	N/A	Non
nom	Le code ISO 4217 de la comme la devise USD pour le dollar américain.	N/A	Oui
organisation	Organisation pour la devise acceptée.	N/A	Oui
état	État de la devise acceptée. Les valeurs valides sont les suivantes : ACTIVE: la devise acceptée peut être utilisée. INACTIVE : la devise acceptée n'est pas disponible.	N/A	Oui
virtualCurrency	Indique si la devise acceptée est une devise virtuelle. Les valeurs valides sont les suivantes : "true" : la devise acceptée est une monnaie virtuelle. "false" : la devise acceptée n'est pas une devise virtuelle.	N/A	Oui