Émission de crédits

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

Introduction

La monétisation vous permet d'accorder des crédits aux développeurs.

Pour un développeur prépayé, un Le crédit apparaît comme une réduction de l'utilisation : cela augmente ou diminue la réserve prépayée du développeur. Semblable à à l'aide d'une carte de débit, les fonds sont prélevés de la réserve prépayée du développeur lorsque développeur achète un lot de produits d'API. Le développeur doit maintenir un équilibre adéquat pour achats. Consultez la section Comment calculer le solde prépayé restant de mon compte ?

Pour un développeur au post-paiement, le crédit s'affiche sous la forme une ligne distincte dans 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 avoir

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 l'avoir s'applique Saisissez le nom dans la zone de texte. À mesure que vous saisissez du texte, une liste déroulante des développeurs/entreprises contenant la chaîne s'affiche. 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	Groupe de produits d'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 API sélectionné auquel le crédit s'applique. Sélectionner Tous les produits ou un seul produit API de la liste.
   Devise	Devise utilisée pour le crédit. La devise est configurée pour le plan tarifaire du groupe de produits de l'API acheté par le développeur et ne peut pas être modifié. 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	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, attribuez à un développeur un crédit pour un lot de produits d'API dans son ensemble. par rapport à 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 L'identification de l'offre groupée de produits de l'API et du plan tarifaire auxquels l'avoir s'applique, respectivement.

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

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

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

• Mois de facturation auquel l'avoir s'applique. Cette valeur est définie par défaut sur mois.
• Année de facturation à laquelle l'avoir 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 de produit API ID, le crédit s'applique à tous les produits API du lot de produits API.

Par exemple, la requête suivante émet 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 Groupe de produits d'API payment et plan tarifaire payment_standard_plan:

Consultez la section Paramètres de requête de l'API pour les crédits afin d'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

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: