Emissione di crediti

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Introduzione

La monetizzazione ti offre la flessibilità di emettere crediti per gli sviluppatori.

Per uno sviluppatore prepagato, un credito viene visualizzato come una riduzione dell'utilizzo, il che aumenta o diminuisce il saldo prepagato dello sviluppatore in futuro. Analogamente all'utilizzo di una carta di debito, i fondi vengono prelevati dal saldo prepagato di uno sviluppatore quando quest'ultimo acquista un pacchetto di prodotti API. Lo sviluppatore deve mantenere un saldo adeguato per gli acquisti. Consulta Come faccio a calcolare il saldo dell'account prepagato rimanente?

Per uno sviluppatore postpagato, un credito viene visualizzato come una riga separata in una fattura, riducendo l'addebito in una fattura.

Esplorare la pagina Crediti

Accedi ed esplora la pagina Crediti, come descritto di seguito.

Emettere un credito

1. Accedi alla pagina Crediti.
2. Fai clic su + Credito.
3. Inserisci le seguenti informazioni:

   Campo	Descrizione
   Mese di fatturazione	Mese di fatturazione in cui si applica il credito. Seleziona un mese dall'elenco.
   Sviluppatore	Nome dello sviluppatore o della società a cui si applica il credito. Inserisci il nome nella casella di testo. Mentre digiti, in un elenco a discesa viene visualizzato un elenco di sviluppatori/società che contengono la stringa. Fai clic sul nome dello sviluppatore o della società nell'elenco a discesa. Nota: dopo aver selezionato uno sviluppatore o una società, vengono visualizzati i campi rimanenti. Se selezioni una società o uno sviluppatore che non ha accettato un piano tariffario, non puoi emettere un credito.
   Pacchetto di prodotti	Pacchetto di prodotti API a cui si applica il credito. Seleziona dall'elenco dei pacchetti di prodotti API disponibili.
   Prodotto	Prodotto API nel pacchetto di prodotti API selezionato a cui si applica il credito. Seleziona Tutti i prodotti o un singolo prodotto API dall'elenco.
   Valuta	Valuta utilizzata per il credito. La valuta è configurata per il piano tariffario nel pacchetto di prodotti API che lo sviluppatore ha acquistato e non può essere modificata. Se in un piano tariffario sono definite più valute, puoi selezionarne una.
   Importo	Importo del credito (nella valuta specificata). Specifica un valore positivo o negativo. Il valore non può essere zero.
   Nota	Nota facoltativa per descrivere il motivo del credito.

4. Fai clic su Salva credito.

Emettere crediti utilizzando l'API

Utilizzando l'API, emetti un credito per uno sviluppatore per un pacchetto di prodotti API nel suo complesso o per l'utilizzo di un prodotto API specifico in un pacchetto di prodotti API.

Per emettere un credito utilizzando l'API, invia una richiesta POST a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, dove {package_id} e {rate-plan_id} definiscono l' identificazione del pacchetto di prodotti API e del piano tariffario a cui si applica il credito, rispettivamente.

Quando invii la richiesta, devi specificare i seguenti parametri di query:

• ID sviluppatore (indirizzo email) a cui si applica il credito.
• Importo del credito.
• Valuta utilizzata per il credito.
• Nota che descrive il motivo del credito.

Facoltativamente, puoi specificare i seguenti parametri di query aggiuntivi:

• Mese di fatturazione a cui si applica il credito. Il valore predefinito è il mese corrente.
• Anno di fatturazione a cui si applica il credito. Il valore predefinito è l'anno corrente.
• Prodotto API a cui si applica il credito. Se non specifichi un ID prodotto API, il credito si applica a tutti i prodotti API nel pacchetto di prodotti API.

Ad esempio, la seguente richiesta emette un credito di 100 $per il mese di fatturazione di aprile 2018 a uno sviluppatore identificato come dev1@myorg.com. Il credito si applica al payment pacchetto di prodotti API e al payment_standard_plan piano tariffario:

Per un elenco completo dei parametri di query che puoi specificare in una richiesta di credito, consulta Parametri di query per 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

Di seguito è riportato un esempio di estratto della risposta:

{
  "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"
}

Parametri di query per l'API Credits

I seguenti parametri di query sono disponibili per l'utilizzo con l'API Credits: