Gérer les devises acceptées

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Introduction

Dans le cadre de la configuration initiale de la monétisation, l'équipe de configuration d'Apigee Edge configure les devises et la devise par défaut acceptée par votre organisation.

Vous pouvez afficher les devises acceptées par votre organisation, ajouter celles acceptées ou Supprimez les devises acceptées (si elles ne sont pas utilisées par un développeur ou un plan tarifaire).

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

Gérez les devises acceptées et définissez la devise par défaut dans "Taxes" et "Devise". 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 individuelle acceptée par votre organisation, envoyez une demande GET à /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, où {supportedCurrency_id} est l'identification de la devise prise en charge à consultée. 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 connaître les devises acceptées par votre organisation, envoyez une demande 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

Pour modifier une devise prise en charge, envoyez une requête PUT à /mint/organizations/{org_name}/{supportedCurrencyId}, où {supportedCurrency_id} est l'identification de la devise prise en charge à mis à 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

Supprimer une devise prise en charge en envoyant une requête DELETE à /mint/organizations/{org_name}/supported-currencies/{currency_id}, où {currency_id} est l'identification de la devise prise en charge à 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.