Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione
Documentazione di Apigee X. Informazioni
Le sezioni seguenti introducono il profilo dell'organizzazione e descrivono come gestirlo utilizzando l'interfaccia utente e l'API.
Informazioni sul profilo dell'organizzazione
Nell'ambito della configurazione iniziale della monetizzazione, il team di configurazione di Apigee Edge configura il profilo della tua organizzazione.
Per aggiungere o aggiornare le informazioni sulla tua organizzazione, a seconda dei casi, devi modificare il profilo dell'organizzazione. Ad esempio, potresti dover aggiornare il tipo di fatturazione, le impostazioni della valuta o il modello fiscale.
Configura le informazioni di base sulla tua organizzazione, tra cui:
- Nome, indirizzo e paese dell'organizzazione
- Tipo di fatturazione (prepagato, posticipato o entrambi), come descritto in Comprendere il tipo di fatturazione
- Ciclo di fatturazione (proporzionale o mese di calendario)
- Valuta di base
- Modello fiscale utilizzato dalla tua organizzazione
Puoi gestire il profilo della tua organizzazione utilizzando l'interfaccia utente e l'API, come descritto in le sezioni seguenti.
Esplorare la pagina Profilo dell'organizzazione
Accedi alla pagina del profilo dell'organizzazione, come descritto di seguito.
Edge
Per accedere alla pagina Profilo organizzazione utilizzando la UI Edge:
- Accedi a apigee.com/edge.
- Seleziona Pubblica > Monetizzazione > Profilo dell'organizzazione nella barra di navigazione a sinistra.
Viene visualizzata la pagina Profilo dell'organizzazione.
Come evidenziato in figura, la pagina Profilo dell'organizzazione consente di:
- Visualizzare le impostazioni attuali del profilo dell'organizzazione
- Modificare le impostazioni del profilo dell'organizzazione, tra cui:
- .
- Nome e informazioni
- Imposte e valuta
- Termini e condizioni, come descritto in Gestione dei termini e condizioni
Perimetrale classico (Private Cloud)
Per accedere alla pagina Profilo organizzazione utilizzando l'interfaccia utente classica di Edge:
- Accedi a
http://ms-ip:9000
, dove ms-ip è Indirizzo IP o nome DNS del nodo del server di gestione. - Seleziona Amministratore > Profilo dell'organizzazione nella barra di navigazione in alto.
Viene visualizzata la pagina Profilo dell'organizzazione.
La pagina Profilo dell'organizzazione ti consente di:
- Visualizzare le impostazioni attuali del profilo dell'organizzazione
- Modificare le impostazioni del profilo dell'organizzazione, tra cui:
- .
- Nome e informazioni
- Imposte e valuta
- Termini e condizioni, come descritto in Gestione dei termini e condizioni
Modificare il profilo dell'organizzazione utilizzando l'interfaccia utente
Per modificare il profilo dell'organizzazione utilizzando l'interfaccia utente:
- Accedi alla pagina del profilo dell'organizzazione.
- Fai clic su Modifica.
- In Nome e informazioni, modifica il nome e il paese dell'organizzazione.
- In Imposte e valuta, modifica i seguenti campi:
Campo Descrizione Modello fiscale Nota:si applica solo se configuri i piani tariffari di condivisione delle entrate e vuoi per generare documenti di fatturazione.
Modello fiscale per i piani tariffari di condivisione delle entrate che identifica il tipo di documenti di fatturazione richiesti.
I valori validi sono:
- Indicato: il fornitore di API agisce in qualità di agente divulgato del sviluppatore. Le entrate lorde (incluse le imposte sulle vendite) raccolte dall'utente finale sono trasmesse allo sviluppatore. La commissione del provider API viene riscossa lo sviluppatore sotto forma di fattura di commissione. Il provider API non gestisce imposta sulle vendite riscossa dall'utente finale ed è responsabilità dello sviluppatore per dichiarare l'imposta sulle vendite.
- Non divulgato: il provider API agisce in qualità di agente riservato di lo sviluppatore, detrae l'imposta riscossa dagli utenti finali e la paga autorità fiscali locali. Lo sviluppatore fattura le entrate nette al fornitore dell'API quota a carico dello sviluppatore (meno imposte sulle vendite e commissione).
- Ibrido: il provider di API agisce come agente divulgato del sviluppatore. Tuttavia, il provider dell'API paga l'imposta sulle vendite riscossa tramite gli abbonati presso le autorità fiscali locali per conto dello sviluppatore. L'API il fornitore passa le entrate rimanenti allo sviluppatore e poi fattura commissioni addebitate.
Valuta Valute supportate dalla tua organizzazione. Per i piani di condivisione delle entrate, tariffario e solo tariffa: la valuta predefinita viene utilizzata per il piano tariffario. Quando crei un tariffario o un piano di solo tariffa, puoi cambiare la valuta da utilizzare scegliendo da un elenco di valute supportate. Se vuoi, puoi impostare l'importo minimo di ricarica che gli sviluppatori di app possono aggiungere al saldo prepagato dell'account per ogni valuta.
Per aggiungere una valuta:
- Fai clic su Aggiungi valuta.
- Seleziona una valuta dal menu a discesa nel campo Valuta.
- Facoltativamente, imposta l'importo minimo che gli sviluppatori di app possono aggiungere al saldo prepagato del loro account nella valuta specificata nel campo Ricarica minima.
- Fai clic su Aggiungi.
- Imposta come valuta predefinita, se necessario, facendo clic sul pulsante di opzione associato.
- Ripeti i passaggi per aggiungere altre valute.
Per eliminare una valuta, posiziona il cursore sulla valuta da eliminare e fai clic su .
- Gestisci i termini e le condizioni, come descritto in Gestire i termini e le condizioni utilizzando l'interfaccia utente.
- Fai clic su Salva.
Gestire il profilo dell'organizzazione tramite l'API
Gestisci il profilo dell'organizzazione utilizzando l'API, come descritto nelle sezioni seguenti.
Visualizzare il profilo dell'organizzazione utilizzando l'API
Visualizzare il profilo dell'organizzazione inviando una richiesta GET a
/mint/organizations/{org_name}
. Ad esempio:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
Di seguito viene fornito un esempio della risposta. Per ulteriori informazioni sulle opzioni visualizzata, consulta Proprietà di configurazione del profilo dell'organizzazione per l'API.
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
Modificare il profilo dell'organizzazione utilizzando l'API
Modifica il profilo dell'organizzazione inviando una richiesta PUT a
/mint/organizations/{org_name}
. Quando modifichi il profilo dell'organizzazione, devi specificare tutte le
proprietà del profilo dell'organizzazione, non solo quelle che stai modificando.
Per modificare la valuta predefinita per l'organizzazione, imposta il valore currency
su
La valuta ISO 4217
della valuta supportata che vuoi impostare come predefinita.
Ad esempio, la seguente chiamata API aggiorna currency
in USD e il modello fiscale
su HYBRID
(i campi aggiornati sono evidenziati nell'esempio). Per ulteriori informazioni
informazioni sulle opzioni visualizzate, consulta Configurazione del profilo dell'organizzazione
proprietà dell'API.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Configurare i tipi di fatturazione prepagata e postpagata utilizzando l'API
Gli account sviluppatore possono essere configurati per l'utilizzo dei seguenti tipi di fatturazione: prepagata, con pagamento posticipato o entrambi.
Con gli account prepagati, gli sviluppatori pagano in anticipo per l'utilizzo delle API. I fondi vengono detratti dal saldo prepagato dello sviluppatore, mantenuto tramite un fornitore di servizi di pagamento integrato. Lo sviluppatore deve mantenere un saldo prepagato sufficiente per acquistare le API.
Con gli account con pagamento posticipato, agli sviluppatori viene addebitato un importo mensile (tramite fattura) alla fine del mese. Lo sviluppatore paga l'utilizzo dei prodotti basati su API in base ai termini di pagamento stabiliti dai piani inclusi nella fattura.
Per configurare i tipi di fatturazione prepagata e con pagamento posticipato per la tua organizzazione, imposta la proprietà supportedBillingType
su uno dei
seguenti valori per indicare quali tipi di fatturazione sono validi: PREPAID
, POSTPAID
o BOTH
. Se imposti il valore su BOTH
,
l'impostazione predefinita sarà PREPAID
quando aggiungi uno sviluppatore di app o un'azienda. In questo caso, puoi impostare esplicitamente il tipo di fatturazione per un'azienda o uno sviluppatore di app utilizzando l'API, come descritto in
Gestione di aziende e sviluppatori di app.
Ad esempio:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Configurare il ciclo di fatturazione utilizzando l'API
Per configurare il ciclo di fatturazione per la tua organizzazione, imposta la proprietà billingCycle
su uno dei seguenti valori:
PRORATED
: la fatturazione si basa sul numero di giorni in cui un prodotto API viene utilizzato in un mese di calendario.CALENDAR_MONTH
: la fatturazione viene eseguita mensilmente.
Ad esempio:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Proprietà di configurazione del profilo dell'organizzazione per l'API
Il profilo dell'organizzazione ti consente di impostare le seguenti proprietà di configurazione utilizzando l'API.
Nome | Descrizione | Predefinito | Obbligatorio? |
---|---|---|---|
address |
Indirizzo dell'organizzazione, che può includere via, città, stato, CAP il codice, il paese e un'indicazione se si tratta dell'indirizzo principale dell'organizzazione. |
N/D | No |
approveTrusted |
Questo flag non è utilizzato. |
N/D | No |
approveUntrusted |
Questo flag non è utilizzato. |
N/D | No |
billingCycle |
Periodo del ciclo di fatturazione. Il valore può essere uno dei seguenti:
Consulta Configurazione del ciclo di fatturazione utilizzando l'API. |
N/D | Sì |
country |
Codice ISO 3166-2 per il paese delle attività per l'organizzazione, ad esempio BR per il Brasile. |
N/D | Sì |
currency |
Codice ISO 4217 per la "base" o valuta contabile utilizzata dall'organizzazione (ad esempio, USD per gli Stati Uniti dollaro). Per i piani di condivisione delle entrate: per il piano viene utilizzata la valuta specificata. Per i piani tariffari (modello di addebito): lo stesso vale per i piani di condivisione delle entrate. Tuttavia, puoi cambiare l'impostazione della valuta scegliendo qualsiasi valuta supportata dal dell'organizzazione. Per i piani solo con tariffe: puoi cambiare l'impostazione della valuta scegliendo una valuta supportata da all'interno dell'organizzazione. |
N/D | Sì |
description |
Breve descrizione dell’organizzazione. |
N/D | No |
hasBillingAdjustment |
Contrassegno che specifica se sono state attivate le regolazioni. Se attivata, puoi apportare aggiustamenti ai dettagli sul traffico registrati dai servizi API per i tuoi prodotti API può essere:
|
N/D | No |
hasBroker |
Flag che specifica se le entrate si basano sul valore netto. Il valore può essere uno dei seguenti le seguenti:
|
N/D | No |
hasSelfBilling |
Flag che indirizza la monetizzazione alla generazione di una fattura con autofatturazione anziché un'entrata la dichiarazione di condivisione. Una fattura di autofatturazione è un documento finanziario che descrive in dettaglio l'importo a causa dello sviluppatore dell'app. Essa funge da fattura per il fornitore di API per conto del sviluppatore di app. Il valore può essere uno dei seguenti:
|
N/D | No |
hasSeparateInvoiceForProduct |
Flag che specifica se viene generata una fattura separata per ogni prodotto API. La può essere:
|
N/D | No |
id |
ID dell'organizzazione. |
N/D | No |
issueNettingStmt |
Flag che specifica se viene generata un'istruzione di compensazione durante la creazione della fatturazione documenti. Il valore può essere uno dei seguenti:
|
N/D | No |
logoUrl |
URL del logo dell'organizzazione. |
N/D | No |
name |
Nome dell'organizzazione. |
N/D | Sì |
netPaymentAdviceNote |
Nota sull'avviso di pagamento netto. |
N/D | No |
nettingStmtPerCurrency |
Contrassegno che specifica se viene generata un'istruzione di compensazione separata per ogni utilizzata. Il valore può essere uno dei seguenti:
|
N/D | No |
regNo |
Numero di registrazione dell'organizzazione. Il numero che inserisci per questa proprietà è visualizzato in fondo ai documenti di fatturazione. |
N/D | No |
selfBillingAsExchOrg |
Se le fatture di autofatturazione sono abilitate, indica se è attiva la piattaforma di scambio pubblicitario le tue organizzazioni. Il valore può essere uno dei seguenti:
|
N/D | No |
selfBillingForAllDev |
Se l'autofatturazione è abilitata, indica se è abilitata per tutti sviluppatori di app. Per impostazione predefinita, le fatture con autofatturazione vengono generate solo per gli sviluppatori di app che hanno firmato un contratto con il fornitore dell'API. Il valore può essere uno dei seguenti:
|
falso | No |
separateInvoiceForFees |
Flag che specifica se è stata pubblicata una fattura separata per le tariffe. Il valore può essere una delle seguenti opzioni:
|
falso | Sì |
status |
Stato dell'organizzazione. I valori validi sono:
|
N/D | No |
supportedBillingType |
Modello di pagamento dello sviluppatore utilizzato per la fatturazione. Il valore può essere uno dei seguenti:
Consulta Configurazione dei tipi di fatturazione prepagata e con pagamento posticipato utilizzando l'API. |
ANTICIPATO | Sì |
taxModel |
Nota:si applica solo se configuri i piani tariffari di condivisione delle entrate e vuoi per generare documenti di fatturazione. Modello fiscale per i piani tariffari di condivisione delle entrate che identifica il tipo di documenti di fatturazione richiesti. I valori validi sono:
|
N/D | Sì |
taxNexus |
Il paese in cui è registrata l'organizzazione ai fini fiscali. |
N/D | No |
taxRegNo |
Numero di registrazione fiscale o IVA dell'organizzazione , se applicabile. Questa proprietà è facoltativa perché il numero di registrazione fiscale o Il numero di partita IVA non è valido in tutti i paesi. Il numero che inserisci per questa viene visualizzato in fondo ai documenti di fatturazione. |
N/D | No |
transactionRelayURL |
URL di un altro sistema a cui è possibile inoltrare le transazioni, ad esempio un indirizzo warehouse. |
N/D | No |
timezone |
L'identificatore del fuso orario per le operazioni dell'organizzazione, ad esempio America/New_York o Europa/Parigi. Abbreviazioni del fuso orario, ad esempio UTC, EST (Eastern Sono supportate anche l'ora standard) o l'ora dell'Europa centrale (Central European Time). |
N/D | Sì |
Sostituire le impostazioni del profilo di monetizzazione per un'azienda o uno sviluppatore di app
Sostituisci le impostazioni del profilo di monetizzazione per un'azienda o uno sviluppatore di app utilizzando l'interfaccia utente o l'API, come descritto nelle sezioni seguenti: