Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Le seguenti sezioni introducono il profilo dell'organizzazione e descrivono come gestirlo utilizzando l'UI 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 relative informazioni, devi modificare il profilo dell'organizzazione, in base alle esigenze. Ad esempio, potrebbe essere necessario 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 (pagamento anticipato, postpagato o entrambi), come descritto in Informazioni sul tipo di fatturazione
- Ciclo di fatturazione (in proporzione o mese di calendario)
- Valuta di base
- Modello fiscale utilizzato dalla tua organizzazione
Puoi gestire il profilo della tua organizzazione utilizzando l'UI e l'API, come descritto nelle sezioni seguenti.
Esplorare la pagina del profilo dell'organizzazione
Accedi alla pagina del profilo dell'organizzazione, come descritto di seguito.
Perimetrale
Per accedere alla pagina del profilo dell'organizzazione utilizzando l'interfaccia utente di Edge:
- Accedi ad apigee.com/edge.
- Seleziona Pubblica > Monetizzazione > Profilo organizzazione nella barra di navigazione a sinistra.
Viene visualizzata la pagina Profilo dell'organizzazione.
Come evidenziato nella figura, 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
- Tasse e valuta
- Termini e condizioni, come descritto in Gestione dei Termini e condizioni
Classic Edge (private cloud)
Per accedere alla pagina del profilo dell'organizzazione utilizzando l'interfaccia utente classica di Edge:
- Accedi a
http://ms-ip:9000
, dove ms-ip è l'indirizzo IP o il nome DNS del nodo del server di gestione. - Seleziona Amministratore > Profilo 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
- Tasse e valuta
- Termini e condizioni, come descritto in Gestione dei Termini e condizioni
Modificare il profilo dell'organizzazione utilizzando l'UI
Per modificare il profilo dell'organizzazione utilizzando l'interfaccia utente:
- Accedi alla pagina Profilo dell'organizzazione.
- Fai clic su Modifica.
- In Nome e informazioni, modifica il nome e il paese dell'organizzazione.
- In Tasse e valuta, modifica i seguenti campi:
Campo Descrizione Modello fiscale Nota: si applica solo se configuri piani tariffari di condivisione delle entrate e vuoi 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:
- Comunicazione: il provider di API agisce in qualità di agente divulgato dello sviluppatore. Le entrate lorde (incluse le imposte sulle vendite) riscosse dall'utente finale vengono trasmesse allo sviluppatore. La commissione del fornitore dell'API viene riscossa dallo sviluppatore sotto forma di fattura con commissione. Il fornitore dell'API non gestisce l'imposta sulle vendite riscossa dall'utente finale ed è responsabilità dello sviluppatore dichiarare l'imposta sulle vendite.
- Non specificato: il provider di API agisce in qualità di agente non dichiarato dello sviluppatore, detrae le imposte riscosse dagli utenti finali e le versa alle autorità fiscali locali. Lo sviluppatore fattura al fornitore dell'API la quota di condivisione delle entrate netta dovuta allo sviluppatore (al netto delle imposte sulle vendite e della commissione del fornitore dell'API).
- Ibrido: il provider di API agisce come agente divulgato dello sviluppatore. Tuttavia, il fornitore dell'API paga l'imposta sulle vendite riscossa dai propri abbonati alle autorità fiscali locali per conto dello sviluppatore. Il provider dell'API passa le entrate rimanenti allo sviluppatore, quindi fattura le commissioni.
Valuta Valute supportate dalla tua organizzazione. Per i piani di condivisione delle entrate, tariffario e solo tariffa, viene utilizzata la valuta predefinita. Quando crei un tariffario o un piano solo con tariffe, puoi cambiare la valuta da utilizzare selezionandola da un elenco di valute supportate. Se vuoi, puoi impostare l'importo di ricarica minimo che gli sviluppatori di app possono aggiungere al saldo prepagato del loro account per ogni valuta.
Per aggiungere una valuta:
- Fai clic su Aggiungi valuta.
- Seleziona una valuta dal menu a discesa nel campo Valuta.
- Se vuoi, 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.
- Se lo desideri, impostala come valuta predefinita 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 condizioni, come descritto in Gestire termini e condizioni utilizzando l'interfaccia utente.
- Fai clic su Salva.
Gestire il profilo dell'organizzazione utilizzando l'API
Gestisci il profilo dell'organizzazione utilizzando l'API, come descritto nelle sezioni seguenti.
Visualizzare il profilo dell'organizzazione utilizzando l'API
Visualizza il profilo della tua 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 è riportato un esempio della risposta. Per ulteriori informazioni sulle opzioni mostrate, consulta Proprietà di configurazione del profilo 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" }
Modifica 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
sul codice valuta ISO 4217 della valuta supportata che vuoi impostare come predefinita.
Ad esempio, la seguente chiamata API aggiorna currency
in USD e l'impostazione del modello fiscale su HYBRID
(i campi aggiornati sono evidenziati nell'esempio). Per ulteriori informazioni sulle opzioni visualizzate, consulta Proprietà della configurazione del profilo dell'organizzazione per l'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 con pagamento posticipato utilizzando l'API
Gli account sviluppatore possono essere configurati in modo da utilizzare i seguenti tipi di fatturazione: prepagata, con pagamento posticipato o entrambi.
Con gli account prepagati, gli sviluppatori pagano in anticipo per l'utilizzo delle tue API. I fondi vengono detratti dal saldo prepagato dello sviluppatore, che viene mantenuto tramite un fornitore di servizi di pagamento integrato. Lo sviluppatore deve avere un saldo prepagato sufficiente per acquistare le API.
Con gli account con pagamento posticipato, gli sviluppatori vengono fatturati con cadenza mensile (tramite una 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
, il valore predefinito sarà PREPAID
quando aggiungi uno sviluppatore di app o una società. In questo caso, puoi impostare esplicitamente il tipo di fatturazione per un'azienda o uno sviluppatore di app utilizzando l'API, come descritto in Gestire 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
Configura 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 effettuata 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 organizzazione per l'API
Il profilo dell'organizzazione ti consente di impostare le seguenti proprietà di configurazione utilizzando l'API.
Nome | Descrizione | Predefinito | Campo obbligatorio? |
---|---|---|---|
address |
Indirizzo dell'organizzazione, che può includere via, città, stato, codice postale, paese e un'indicazione se si tratta dell'indirizzo principale dell'organizzazione. |
N/A | No |
approveTrusted |
Questo flag non è utilizzato. |
N/A | No |
approveUntrusted |
Questo flag non è utilizzato. |
N/A | No |
billingCycle |
Periodo del ciclo di fatturazione. Il valore può essere uno dei seguenti:
Consulta Configurazione del ciclo di fatturazione tramite l'API. |
N/A | Sì |
country |
Codice ISO 3166-2 per il paese di attività dell'organizzazione, ad esempio BR per il Brasile. |
N/A | Sì |
currency |
Codice ISO 4217 per la valuta "base" o contabile utilizzata dall'organizzazione (ad esempio USD per il dollaro degli Stati Uniti). 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 modificare l'impostazione della valuta scegliendo qualsiasi valuta supportata dall'organizzazione. Per i piani solo a tariffe: puoi modificare l'impostazione della valuta in qualsiasi valuta supportata dall'organizzazione. |
N/A | Sì |
description |
Breve descrizione dell'organizzazione. |
N/A | No |
hasBillingAdjustment |
Flag che specifica se sono stati attivati gli aggiustamenti. Se l'opzione è abilitata, puoi apportare modifiche ai dettagli del traffico registrati dai servizi API per i tuoi prodotti API. Il valore può essere uno dei seguenti:
|
N/A | No |
hasBroker |
Flag che specifica se le entrate sono basate sul valore netto. Il valore può essere uno dei seguenti:
|
N/A | No |
hasSelfBilling |
Flag che indirizza la monetizzazione alla generazione di una fattura con fatturazione automatica invece di un estratto conto sulla quota di condivisione delle entrate. Una fattura con l'autofatturazione è un documento finanziario che descrive nel dettaglio l'importo dovuto allo sviluppatore dell'app. Agisce da fattura al fornitore di API per conto dello sviluppatore dell'app. Il valore può essere uno dei seguenti:
|
N/A | No |
hasSeparateInvoiceForProduct |
Flag che specifica se viene generata una fattura separata per ogni prodotto API. Il valore può essere uno dei seguenti:
|
N/A | No |
id |
ID dell'organizzazione. |
N/A | No |
issueNettingStmt |
Flag che specifica se viene generata un'istruzione di compensazione durante la creazione dei documenti di fatturazione. Il valore può essere uno dei seguenti:
|
N/A | No |
logoUrl |
URL del logo dell'organizzazione. |
N/A | No |
name |
Nome dell'organizzazione. |
N/A | Sì |
netPaymentAdviceNote |
Nota di consulenza sui pagamenti netti. |
N/A | No |
nettingStmtPerCurrency |
Flag che specifica se viene generata una dichiarazione di compensazione separata per ogni valuta utilizzata. Il valore può essere uno dei seguenti:
|
N/A | No |
regNo |
Numero di registrazione dell'organizzazione. Il numero inserito per questa proprietà viene visualizzato in fondo ai documenti di fatturazione. |
N/A | No |
selfBillingAsExchOrg |
Se le fatture di autofatturazione sono abilitate, indica se sono abilitate per le organizzazioni di scambio. Il valore può essere uno dei seguenti:
|
N/A | No |
selfBillingForAllDev |
Se le fatture di autofatturazione sono abilitate, indica se questa funzionalità è attiva per tutti gli sviluppatori di app. Per impostazione predefinita, le fatture di autofatturazione vengono generate solo per gli sviluppatori di app che hanno firmato un contratto con il provider di API. Il valore può essere uno dei seguenti:
|
false | No |
separateInvoiceForFees |
Flag che specifica se è stata pubblicata una fattura separata per le tariffe. Il valore può essere uno dei seguenti:
|
false | Sì |
status |
Stato dell'organizzazione. I valori validi sono:
|
N/A | No |
supportedBillingType |
Modello di pagamento dello sviluppatore utilizzato per la fatturazione. Il valore può essere uno dei seguenti:
Vedi Configurare i tipi di fatturazione prepagata e con pagamento posticipato utilizzando l'API. |
PAGAMENTO ANTICIPATO | Sì |
taxModel |
Nota: si applica solo se configuri piani tariffari di condivisione delle entrate e vuoi 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/A | Sì |
taxNexus |
Il paese in cui l'organizzazione è registrata ai fini fiscali. |
N/A | No |
taxRegNo |
Numero di registrazione fiscale o di partita IVA (imposta sul valore aggiunto), se applicabile. Questa proprietà è facoltativa perché il numero di registrazione fiscale o il numero di partita IVA non si applica in tutti i paesi. Il numero inserito per questo parametro viene visualizzato in fondo ai documenti di fatturazione. |
N/A | No |
transactionRelayURL |
URL di un altro sistema a cui è possibile inoltrare le transazioni, ad esempio un data warehouse. |
N/A | No |
timezone |
L'identificatore del fuso orario per le operazioni dell'organizzazione, ad esempio America/New_York o Europa/Parigi. Sono supportate anche le abbreviazioni dei fusi orari, come UTC, EST (Eastern Standard Time) o CET (Central European Time). |
N/A | 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 seguenti sezioni: