Emissione di crediti

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Introduzione

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

Per uno sviluppatore prepagato, un credito viene visualizzato come riduzione dell'utilizzo, aumentando o diminuendo il saldo prepagato dello sviluppatore in futuro. Come nel caso 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 l'articolo Come faccio a calcolare il saldo prepagato rimanente dell'account?

Per uno sviluppatore con pagamento posticipato, il credito viene visualizzato come riga separata in una fattura, riducendo l'addebito nella fattura.

Esplorazione della pagina dei crediti

Accedi alla pagina Crediti ed esplorala, come descritto di seguito.

Emissione di un credito

1. Accedi alla pagina Crediti.
2. Fai clic su + Credito.
3. Immetti 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 dell'azienda a cui si applica il credito. Inserisci il nome nella casella di testo. Durante la digitazione, viene visualizzato in un menu a discesa un elenco degli sviluppatori o delle aziende che contengono la stringa. Fai clic sul nome dello sviluppatore o dell'azienda 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 un'opzione 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 acquistato dallo sviluppatore 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.

Emissione di crediti tramite l'API

Utilizzando l'API, assegna un credito a 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 rispettivamente l'identificazione del pacchetto di prodotti API e del piano tariffario a cui si applica il credito.

Quando invii la richiesta, devi specificare come parametri di ricerca:

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

Facoltativamente, puoi specificare i seguenti parametri di query aggiuntivi:

• Mese di fatturazione a cui si applica il credito. Per impostazione predefinita, questo valore corrisponde al mese corrente.
• Anno di fatturazione a cui si applica il credito. Per impostazione predefinita, questo valore corrisponde all'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 pacchetto di prodotti dell'API payment e al piano tariffario payment_standard_plan:

Consulta l'API Parametri di query per i crediti per un elenco completo dei parametri di query che puoi specificare in una richiesta di credito.

$ 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 dei crediti

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

Nome	Descrizione	Predefinito	Campo obbligatorio?
billingMonth	Mese di fatturazione per il quale si applica il credito, ad esempio APRILE.	N/A	No
billingYear	Anno di fatturazione a cui si applica il credito, ad esempio il 2018.	N/A	No
currencyId	Valuta utilizzata per il credito. La valuta è configurata per il piano tariffario nel pacchetto di prodotti API acquistato dallo sviluppatore e non può essere modificata.	N/A	Sì
developerId	Nome dello sviluppatore o dell'azienda a cui si applica il credito.	N/A	Sì
productId	Prodotto API a cui si applica il credito. Se non specifichi un ID prodotto, il credito si applica a tutti i prodotti API nel pacchetto di prodotti API.	N/A	No
transactionAmount	Importo del credito (nella valuta specificata). Specifica un valore positivo o negativo. Il valore non può essere zero.	N/A	Sì
transactionNote	Tieni presente che descrive il motivo per cui hai ricevuto il riconoscimento.	N/A	Sì