Émission de crédits

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

Introduction

La monétisation vous donne la possibilité d'attribuer des crédits de développeur.

Pour un développeur prépayé, un crédit s'affiche comme une réduction de l'utilisation, ce qui augmente ou diminue le solde prépayé du développeur par la suite. Comme pour une carte de débit, les fonds sont retirés de la réserve prépayée du développeur lorsqu'il achète un lot de produits API. Le développeur doit maintenir un solde suffisant pour les achats. Consultez l'article Comment calculer le solde prépayé restant de mon compte ?

Pour un développeur post-payé, un crédit s'affiche sur une ligne distincte de la facture, ce qui réduit le montant facturé.

Explorer la page "Crédits"

Accédez à la page "Crédits" et explorez-la, comme décrit ci-dessous.

Périphérie

Pour accéder à la page Crédits à l'aide de l'interface utilisateur Edge:

  1. Connectez-vous à apigee.com/edge.
  2. Sélectionnez Publier > Monétisation > Crédits dans la barre de navigation de gauche.

La page "Crédits" s'affiche.

Comme le montre la figure, la page "Crédits" vous permet de:

  • Afficher les informations récapitulatives sur tous les crédits, y compris le nom du bénéficiaire, le montant du crédit, la date et l'heure d'entrée en vigueur du crédit, le groupe de produits d'API et les produits d'API auxquels le crédit s'applique, ainsi que toute note ajoutée
  • Émettre un crédit
  • Rechercher dans la liste des crédits

Classic Edge (cloud privé)

Pour accéder à la page Crédits à l'aide de l'interface utilisateur Classic Edge:

  1. Connectez-vous à http://ms-ip:9000, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion.
  2. Sélectionnez Monétisation > Rapports de monétisation dans la barre de navigation supérieure.

La page "Crédits" vous permet de:

  • Afficher les informations récapitulatives sur tous les crédits, y compris le nom du bénéficiaire, le montant du crédit, la date et l'heure d'entrée en vigueur du crédit, le groupe de produits d'API et les produits d'API auxquels le crédit s'applique, ainsi que toute note ajoutée
  • Émettre un crédit
  • Rechercher dans la liste des crédits

Émettre un crédit

  1. Accédez à la page "Crédits".
  2. Cliquez sur + Crédit.
  3. Saisissez les informations suivantes :
    Champ Description
    Mois de facturation

    Mois de facturation au cours duquel l'avoir s'applique. Sélectionnez un mois dans la liste.

    Développeur

    Nom du développeur ou de l'entreprise auquel le crédit s'applique. Saisissez le nom dans la zone de texte. Au fur et à mesure de la saisie, une liste des développeurs/entreprises qui contiennent la chaîne s'affiche dans un menu déroulant. Cliquez sur le nom du développeur ou de l'entreprise dans la liste déroulante.

    Remarque: Une fois que vous avez sélectionné un développeur ou une entreprise, les champs restants s'affichent. Si vous sélectionnez une entreprise ou un développeur qui n'a pas accepté de plan tarifaire, vous ne pouvez pas émettre de crédit.

    Lot de produits

    Lot de produits API auquel le crédit s'applique. Faites votre choix dans la liste des lots de produits API disponibles.

    Produit

    Produit d'API dans le lot de produits d'API sélectionné auquel le crédit s'applique. Sélectionnez Tous les produits ou un seul produit API dans la liste.

    Currency

    Devise utilisée pour le crédit. La devise est configurée pour le plan tarifaire dans le lot de produits API acheté par le développeur et ne peut pas être modifiée. Si plusieurs devises sont définies dans un plan tarifaire, vous pouvez en sélectionner une.

    Montant

    Montant du crédit (dans la devise spécifiée). Spécifiez une valeur positive ou négative. La valeur ne peut pas être nulle.

    Remarque

    Note facultative décrivant le motif de l'avoir.

  4. Cliquez sur Enregistrer le crédit.

Émettre des crédits à l'aide de l'API

À l'aide de l'API, accordez à un développeur un crédit pour un lot de produits API dans son ensemble ou contre l'utilisation d'un produit API spécifique dans un lot de produits API.

Pour émettre un crédit à l'aide de l'API, envoyez une requête POST à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, où {package_id} et {rate-plan_id} définissent respectivement l'identification du groupe de produits de l'API et du plan tarifaire auxquels le crédit s'applique.

Lorsque vous émettez la requête, vous devez la spécifier en tant que paramètres de requête:

  • ID du développeur (adresse e-mail) auquel le crédit s'applique.
  • Montant de l'avoir.
  • Devise utilisée pour le crédit.
  • Note décrivant le motif de l'avoir.

Vous pouvez également spécifier les paramètres de requête supplémentaires suivants:

  • Mois de facturation auquel le crédit s'applique. Cette valeur est définie par défaut sur le mois en cours.
  • Année de facturation à laquelle le crédit s'applique. Par défaut, cette valeur est définie sur l'année en cours.
  • Produit d'API auquel le crédit s'applique. Si vous ne spécifiez pas d'ID produit API, le crédit s'applique à tous les produits API du lot de produits API.

Par exemple, la requête suivante accorde un crédit de 100 $pour le mois de facturation d'avril 2018 à un développeur identifié comme dev1@myorg.com. Le crédit s'applique au lot de produits API payment et au plan tarifaire payment_standard_plan:

Consultez la section Paramètres de requête pour l'API crédits pour obtenir la liste complète des paramètres de requête que vous pouvez spécifier dans une demande de crédit.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

Vous trouverez ci-dessous un exemple d'extrait de la réponse:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

Paramètres de requête pour l'API Credits

Les paramètres de requête suivants peuvent être utilisés avec l'API des crédits:

Nom Description Par défaut Obligatoire ?
billingMonth

Mois de facturation pour lequel le crédit s'applique (par exemple, avril).

N/A Non
billingYear

Année de facturation pour laquelle le crédit s'applique (par exemple, 2018).

N/A Non
currencyId

Devise utilisée pour le crédit. La devise est configurée pour le plan tarifaire dans le lot de produits API acheté par le développeur et ne peut pas être modifiée.

N/A Oui
developerId

Nom du développeur ou de l'entreprise auquel le crédit s'applique.

N/A Oui
productId

Produit d'API auquel le crédit s'applique. Si vous ne spécifiez pas d'ID produit, le crédit s'applique à tous les produits API du lot de produits API.

N/A Non
transactionAmount

Montant du crédit (dans la devise spécifiée). Spécifiez une valeur positive ou négative. La valeur ne peut pas être nulle.

N/A Oui
transactionNote

Notez que le motif du crédit est indiqué.

N/A Oui