Gérer les devises acceptées

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

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'interface utilisateur

Gérez les devises acceptées et définissez la devise par défaut dans la section "Taxes et devise" de la page "Profil de l'organisation". Pour en savoir plus, consultez Gérer le profil d'organisation à l'aide de l'interface utilisateur.

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 spécifique 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} correspond à l'identification 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 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
}

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

Ajoutez les 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.
  • État de la devise, c'est-à-dire si elle peut être utilisée ou non.
  • Organisation pour laquelle la devise acceptée sera ajoutée.

Vous pouvez également définir:

  • Limite de crédit pour une devise acceptée (pour les développeurs utilisant le post-paiement uniquement).
  • Crédit minimal pour une devise acceptée (développeurs prépayés uniquement).

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

Par exemple, le code suivant permet d'ajouter 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 compatible lorsque vous modifiez le profil de l'organisation, comme décrit dans la section Gérer le profil d'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} correspond à l'identification de la devise acceptée à mettre à jour. Vous devez spécifier les propriétés mises à jour dans le corps de la requête, 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

Pour supprimer une devise acceptée, envoyez 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 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.

Nom Description Par défaut Requis ?
creditLimit

Cette propriété ne s'applique qu'aux développeurs ayant opté pour le post-paiement. 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 qui ont choisi le prépaiement. Montant minimal que les développeurs peuvent ajouter au solde prépayé de leur compte dans la devise spécifiée.

N/A Non
name

Code ISO 4217 pour la devise, par exemple USD pour le dollar américain.

N/A Oui
organisation

Organisation de la devise acceptée.

N/A Oui
reconnu

État de la devise acceptée. Les valeurs valides sont les suivantes :

  • ACTIVE: les devises acceptées peuvent être utilisées.
  • 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 la monnaie virtuelle.
  • "false" : la devise acceptée n'est pas une devise virtuelle.
N/A Oui