Émission de crédits

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Introduction

La monétisation vous permet d'émettre des crédits pour les développeurs.

Pour un développeur prépayé, un crédit apparaît comme une réduction de l'utilisation, ce qui augmente ou diminue le solde prépayé du développeur à l'avenir. Comme pour l'utilisation d'une carte de débit, les fonds sont retirés de la réserve prépayée d'un développeur lorsque celui-ci achète un groupe de produits d'API. Le développeur doit disposer d'un solde suffisant pour effectuer des achats. Consultez Comment calculer le solde restant du compte prépayé ?

Pour un développeur postpayé, un crédit apparaît comme une ligne distincte d'une facture, ce qui réduit les frais sur une facture.

Explorer la page "Crédits"

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

É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 auquel le crédit 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. À mesure que vous tapez, une liste des développeurs/entreprises contenant 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 (COLLECTION)	Groupe de produits d'API auquel le crédit s'applique. Sélectionnez un groupe dans la liste des groupes de produits d'API disponibles.
   Produit	Produit d'API dans le groupe de produits d'API sélectionné auquel le crédit s'applique. Sélectionnez Tous les produits ou un seul produit d'API dans la liste.
   Devise	Devise utilisée pour le crédit. La devise est configurée pour le plan tarifaire dans le groupe de produits d'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 égale à zéro.
   Remarque	Remarque facultative pour décrire le motif du crédit.

4. Cliquez sur Enregistrer le crédit.

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

À l'aide de l'API, émettez un crédit pour un développeur sur un groupe de produits d'API dans son ensemble ou sur l'utilisation d'un produit d'API spécifique dans un groupe de produits d'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 l' identification du groupe de produits d'API et du plan tarifaire auxquels le crédit s'applique, respectivement.

Lorsque vous envoyez la requête, vous devez spécifier les paramètres de requête suivants :

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

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. Cette valeur est définie par défaut sur l'année en cours.
• Produit d'API auquel le crédit s'applique. Si vous ne spécifiez pas d'ID de produit d'API, le crédit s'applique à tous les produits d'API du groupe de produits d'API.

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

Pour obtenir la liste complète des paramètres de requête que vous pouvez spécifier dans une requête de crédit, consultez Paramètres de requête pour l'API Credits.

$ 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

Voici 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 Credits :