Gérer les devises acceptées

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**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 acceptées 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 plan tarifaire).

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

Gérez les devises acceptées et définissez la devise par défaut dans la section "Taxe et devise" de la page "Profil de l'organisation". Pour en savoir plus, consultez la section Gérer 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

Affichez une devise individuelle acceptée par votre organisation ou toutes les devises acceptées par votre organisation.

Pour afficher une devise individuelle acceptée par votre organisation, envoyez une requête GET à /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, où {supportedCurrency_id} est l'identifiant de la devise acceptée à 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
}

Ajouter des devises acceptées à l'aide de l'API

Ajoutez des devises acceptées en envoyant une requête POST à /mint//organizations/{org_name}/supported-currencies. Pour chaque devise acceptée que vous ajoutez, vous devez spécifier les informations suivantes dans le corps de la requête :

• Nom de la devise acceptée. Le nom correspond au code ISO 4217 de la devise, par exemple USD pour le dollar américain.
• Nom à afficher.
• Description.
• Indique si la devise est virtuelle ou non.
• État de la devise, c'est-à-dire si elle est disponible ou non.
• Organisation pour laquelle la devise acceptée sera ajoutée.

Vous pouvez également définir les éléments suivants :

• Limite de crédit pour une devise acceptée (développeurs avec post-paiement uniquement).
• Montant minimal de recharge pour une devise acceptée (développeurs avec prépaiement uniquement).

Pour en savoir plus, consultez la section Propriétés de configuration des devises acceptées.

Par exemple, le code suivant ajoute une devise acceptée pour une organisation :

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

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 un code de devise ISO 4217 accepté lorsque vous modifiez le profil de l'organisation, comme décrit dans la section Gérer le profil de l'organisation à 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} est l'identifiant 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'ID de la devise acceptée. Par exemple, l'appel d'API suivant modifie la description et le nom à afficher d'une devise acceptée (les propriétés mises à jour sont mises en surbrillance 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} est l'identifiant 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 des devises pour l'API

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