Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Introduzione
La monetizzazione ti consente di pubblicare rimborsi per gli sviluppatori per le "transazioni di acquisto". Supponi di essere un operatore di telefonia mobile e di offrire agli sviluppatori un'API di pagamento per addebitare agli abbonati di dispositivi mobili l'acquisto di un'applicazione o di contenuti all'interno dell'applicazione. Ogni volta che un abbonato utilizza l'API per effettuare un acquisto, si tratta di una transazione di acquisto.
Le transazioni di acquisto possono comportare rimborsi. Ad esempio, i contenuti potrebbero non essere consegnati oppure la terza parte potrebbe non essere soddisfatta dell'acquisto. In questi casi, lo sviluppatore emette un rimborso alla terza parte. La monetizzazione ti consente di effettuare un rimborso analogo. Ciò è particolarmente attinente ai piani di condivisione delle entrate.
Immagina che lo sviluppatore che ha emesso il rimborso a favore dell'abbonato mobile abbia acquistato un piano di quota di condivisione delle entrate per il tuo prodotto API. Supponiamo che il piano richieda allo sviluppatore di ricevere il 70% del prezzo netto/lordo della transazione di acquisto. La pubblicazione di un rimborso comporta l'annullamento della transazione di acquisto, vale a dire la detrazione del 70% dal pagamento dovuto allo sviluppatore per il mese in cui è stato applicato il rimborso (il mese potrebbe essere diverso da quello in cui è avvenuta la transazione di acquisto effettiva).
Pubblicazione di un rimborso utilizzando l'interfaccia utente classica di Edge (solo Edge per il cloud privato)
Puoi pubblicare un rimborso per qualsiasi transazione di acquisto "riuscito", ovvero se l'API ha addebitato correttamente la terza parte e per cui non hai già emesso un rimborso totale. La pubblicazione di un rimborso comporta la creazione di una transazione di rimborso con un ID transazione padre, dove l'ID transazione è l'ID della transazione di acquisto.
Puoi pubblicare un rimborso per l'intero importo della transazione di acquisto originale o per un importo parziale. Puoi anche pubblicare più rimborsi parziali, ma l'importo totale dei rimborsi non può essere superiore all'importo di acquisto originale.
Per pubblicare un rimborso:
- Nella scheda Monetizzazione, seleziona Rimborsi.
Viene visualizzata la pagina Rimborsi.
- Nel menu a discesa Mese di fatturazione, seleziona il mese in cui è avvenuta la transazione di acquisto. Quindi, fai clic su + Rimborsi.
Viene visualizzato un elenco di tutte le transazioni di acquisto andate a buon fine per il mese selezionato.
Puoi filtrare l'elenco dei rimborsi per nome dello sviluppatore o cercando la transazione effettiva.
Per filtrare in base allo sviluppatore, selezionalo dal menu a discesa Sviluppatore. Viene visualizzato un elenco solo delle transazioni relative allo sviluppatore selezionato.
Per filtrare in base all'ID transazione, inserisci l'ID transazione dell'acquisto originale che vuoi rimborsare. Verrà restituita la transazione per quell'ID.
- Seleziona la casella Seleziona nelle righe relative alle transazioni che vuoi rimborsare.
- Seleziona Totale o Parziale nel menu a discesa Tipo.
Se selezioni Totale, ti verrà rimborsato l'importo totale dell'acquisto. Se selezioni Parziale, verrà rimborsato un importo parziale dell'acquisto.
Se selezioni Parziale, inserisci l'importo del rimborso parziale nel campo Importo. Puoi rimborsare solo fino all'importo totale dell'acquisto. Se hai già pubblicato un rimborso parziale, puoi inserire un importo solo fino a quello rimanente dell'acquisto. Inoltre, se la transazione di acquisto originale prevede sia prezzi lordi che netti, dovrai anche indicare se l'importo parziale che vuoi rimborsare è lordo o netto.
- Fai clic su Salva per elaborare il rimborso (o su Annulla per annullare).
Il rimborso viene pubblicato nel mese dell'acquisto originale se il mese di fatturazione è ancora aperto, altrimenti il rimborso viene pubblicato alla data corrente.
Per il rimborso parziale, il rimborso viene elaborato per l'importo parziale e l'eventuale quota di condivisione delle entrate viene detratta in base alla proporzione tra l'importo parziale e l'intero importo. Nell'esempio di rimborso parziale riportato sopra, l'importo parziale è 0,50/1,12 = 45% del prezzo lordo, quindi verrà detratto il 45% della quota di condivisione delle entrate dello sviluppatore.
Controllo nell'interfaccia utente dell'elaborazione di un rimborso in corso
Puoi determinare se un rimborso è stato elaborato selezionando il mese di fatturazione nella parte superiore della pagina Rimborsi. Questo è il mese dell'acquisto, se il mese di fatturazione è ancora aperto, oppure il mese corrente se quello di fatturazione è chiuso. Viene visualizzato un elenco di tutti i rimborsi pubblicati nel corso del mese.
Pubblicazione di un rimborso tramite l'API
Per pubblicare un rimborso, invia una richiesta POST a /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, dove {package_id} è l'identificazione del pacchetto API a cui si applica il rimborso.
Quando invii la richiesta, devi specificare come parametri di ricerca:
- L'identificazione della transazione di acquisto rimborsata.
- Il tipo di entrate (
GROSSoNET) della transazione di acquisto. - L'importo del rimborso.
- Una nota che descrive il motivo del rimborso.
Facoltativamente, puoi identificare come parametro URL un pacchetto API a cui si applica il rimborso.
Consulta le impostazioni di configurazione del rimborso per un elenco completo dei parametri URL che puoi specificare in una richiesta di rimborso.
Ad esempio, la seguente richiesta emette un rimborso per una transazione di acquisto. L'importo del rimborso corrisponde al 50% dell'importo lordo della transazione di acquisto.
$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/refund-transactions?revenueType=GROSS&refundAmount=0.5&parentTxId=abf50909-2492-4bf5-8704-ade05f4d43b3&transactionNote=Refund for purchase transaction" \
-u email:password
La risposta dovrebbe essere simile alla seguente (viene mostrata solo una parte):
{
"application" : {
...
},
"product" : [ {
...
{
"customAtt1Name" : "user",
"description" : "Payment",
"displayName" : "Payment",
"id" : "payment",
"name" : "payment",
"organization" : {
...
},
"status" : "CREATED",
"transactionSuccessCriteria" : "Status=='200 OK'"
} ],
...
},
"currency" : "USD",
"developer" : {
...
"legalName" : "DEV ONE",
"name" : "Dev One",
"organization" : {
...
},
...
},
"endTime" : "2013-09-01 21:59:59",
"environment" : "PROD",
"euroExchangeRate" : 0.8123,
"gbpExchangeRate" : 0.6910,
"grossPrice" : 0.5,
"id" : "61f7eb88-f8cc-4cda-afd8-4a61fba3dd33",
"isRevOnGrossOrNet" : "NET",
"isVirtualCurrency" : false,
"notes" : "Refund for purchase transaction",
"itemDesc" : "test application",
"netPrice" : 0.4464,
"orgRevenueShareAmount" : 0.1339,
"parentId" : "abf50909-2492-4bf5-8704-ade05f4d43b3",
"pkgId" : "myorg@@@payment",
"pkgRatePlanProductName" : "Payment",
...
},
"ratePlanLevel" : "STANDARD",
"revenueShareAmount" : 0.3125,
"startTime" : "2013-09-01 21:59:59",
"status" : "SUCCESS",
"tax" : 0.0536,
"taxModel" : "UNDISCLOSED",
"txProviderStatus" : "SUCCESS",
"type" : "REFUND",
"usdExchangeRate" : 1.0724,
"utcEndTime" : "2013-09-01 21:59:59",
"utcStartTime" : "2013-09-01 21:59:59"
}
Impostazioni di configurazione dei rimborsi per l'API
I seguenti parametri di query possono essere specificati in una richiesta di rimborso:
| Nome | Descrizione | Predefinito | Campo obbligatorio? |
|---|---|---|---|
monetizationPackageId |
Il pacchetto API a cui si applica il rimborso. |
N/A | No |
parentTxId |
La transazione di acquisto da rimborsare. |
N/A | Sì |
revenueType |
Il tipo di entrate ( |
N/A | Sì |
refundAmount |
L'importo del rimborso. |
N/A | Sì |
transactionNote |
Una nota di testo che descriva il motivo del rimborso. |
N/A | Sì |
Passaggi successivi
Scopri come pianificare i job relativi alla monetizzazione e i job pianificati automaticamente in Pianificare i job di monetizzazione.