Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
Le sezioni seguenti illustrano 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.
Devi modificare il profilo dell'organizzazione per aggiungere o aggiornare le informazioni sulla tua organizzazione, a seconda dei casi. Ad esempio, potrebbe essere necessario aggiornare il tipo di fatturazione, le impostazioni di valuta o il modello fiscale.
Configura le informazioni di base sulla tua organizzazione, tra cui:
- Nome, indirizzo e paese di attività dell'organizzazione
- Tipo di fatturazione (prepagato, postpaid o entrambi), come descritto in Informazioni sul 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 nelle sezioni seguenti.
Esplorare la pagina Profilo dell'organizzazione
Accedi alla pagina Profilo dell'organizzazione, come descritto di seguito.
Edge
Per accedere alla pagina Profilo dell'organizzazione utilizzando l'interfaccia utente di Edge:
- Accedi ad apigee.com/edge.
- Seleziona Pubblicazione > Monetizzazione > Profilo dell'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 del profilo dell'organizzazione attuale
- Modifica le impostazioni del profilo dell'organizzazione, tra cui:
- Nome e informazioni
- Imposte e valuta
- Termini e condizioni, come descritto in Gestire i Termini e condizioni
Edge classico (private cloud)
Per accedere alla pagina 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 Amministrazione > 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 del profilo dell'organizzazione attuale
- Modifica le impostazioni del profilo dell'organizzazione, tra cui:
- Nome e informazioni
- Imposte e valuta
- Termini e condizioni, come descritto in Gestire i 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 Profilo dell'organizzazione.
- Fai clic su Modifica.
- In Nome e informazioni, modifica il nome dell'organizzazione e il paese di attività.
- In Tasse e valuta, modifica i seguenti campi:
Campo Descrizione Modello fiscale Nota:si applica solo se configuri piani tariffari con condivisione delle entrate e vuoi generare documenti di fatturazione.
Modello fiscale per i piani tariffari con condivisione delle entrate che identifica il tipo di documenti di fatturazione richiesti.
I valori validi includono:
- Comunicato: il fornitore dell'API agisce come agente divulgato dello sviluppatore. Le entrate lorde (incluse le imposte sulle vendite) riscosse dall'utente finale vengono comunicate allo sviluppatore. La commissione del fornitore dell'API viene riscossa dall' sviluppatore sotto forma di fattura della commissione. Il fornitore dell'API non gestisce l'imposta sulle vendite riscossa dall'utente finale ed è responsabilità dello sviluppatore dichiararla.
- Non divulgato: il fornitore dell'API agisce come agente non divulgato dello sviluppatore, detrae l'imposta riscossa dagli utenti finali e la paga alle autorità fiscali locali. Lo sviluppatore fattura al fornitore dell'API la quota di utile netto dovuta allo sviluppatore (al netto delle imposte sulle vendite e della commissione del fornitore dell'API).
- Ibrida: il fornitore dell'API agisce come agente divulgato dello sviluppatore. Tuttavia, il fornitore dell'API paga l'imposta sulle vendite riscossa dagli abbonati alle autorità fiscali locali per conto dello sviluppatore. Il fornitore dell'API gira le entrate rimanenti allo sviluppatore, poi fattura le commissioni.
Valuta Le valute supportate dalla tua organizzazione. Per i piani di condivisione delle entrate, di tariffa e solo di tariffa, viene utilizzata la valuta predefinita per il piano tariffario. Quando crei una tariffa o un piano solo con tariffe, puoi cambiare la valuta da utilizzare selezionandola da un elenco di valute supportate. Facoltativamente, puoi impostare l'importo minimo di ricarica che gli sviluppatori di app possono aggiungere al saldo del proprio account prepagato 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 del proprio account prepagato nella valuta specificata nel campo Ricarica minima.
- Fai clic su Aggiungi.
- Se vuoi, 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 che vuoi 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 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 di risposta. Per ulteriori informazioni sulle opzioni visualizzate, consulta le 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
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 mostrate, consulta le proprietà di 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
Configura i tipi di fatturazione prepagata e postpaid utilizzando l'API
Gli account sviluppatore possono essere configurati per utilizzare i seguenti tipi di fatturazione: prepagata, postpaid o entrambi.
Con gli account prepagati, gli sviluppatori pagano in anticipo l'utilizzo delle tue API. I fondi vengono detratti dal saldo prepagato dello sviluppatore, gestito tramite un fornitore di servizi di pagamento integrato. Lo sviluppatore deve mantenere un saldo prepagato sufficiente per l'acquisto delle API.
Con gli account postpaid, la fatturazione viene effettuata mensilmente (tramite una fattura) alla fine del mese. Lo sviluppatore paga l'utilizzo dei prodotti API in base ai termini di pagamento impostati dai piani inclusi nella fattura.
Per configurare i tipi di fatturazione prepagata e postpaid 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 un'azienda. In questo caso, puoi impostare esplicitamente il tipo di fatturazione per un'azienda o uno sviluppatore di app che utilizza 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
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 avviene 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 la via, la città, lo stato, il codice postale, il paese e un'indicazione se si tratta dell'indirizzo principale dell'organizzazione. |
N/D | No |
approveTrusted |
Questo flag non viene utilizzato. |
N/D | No |
approveUntrusted |
Questo flag non viene utilizzato. |
N/D | No |
billingCycle |
Periodo del ciclo di fatturazione. Il valore può essere uno dei seguenti:
Consulta Configurare il ciclo di fatturazione utilizzando l'API. |
N/D | Sì |
country |
Codice ISO 3166-2 per il paese di attività dell'organizzazione, ad esempio BR per il Brasile. |
N/D | Sì |
currency |
Codice ISO 4217 per la valuta "di base" o contabile utilizzata dall'organizzazione (ad esempio USD per il dollaro statunitense). Per i piani di condivisione delle entrate: viene utilizzata la valuta specificata per il piano. Per i piani tariffari (modello di addebito): vale lo stesso discorso per i piani di condivisione delle entrate. Tuttavia, puoi modificare l'impostazione della valuta su qualsiasi valuta supportata dall'organizzazione. Per i piani solo per le commissioni: puoi modificare l'impostazione della valuta su qualsiasi valuta supportata dall'organizzazione. |
N/D | Sì |
description |
Breve descrizione dell'organizzazione. |
N/D | No |
hasBillingAdjustment |
Flag che specifica se gli aggiustamenti sono abilitati. Se abilitato, puoi apportare aggiustamenti ai dettagli sul traffico registrati da API Services per i tuoi prodotti API. Il valore può essere uno dei seguenti:
|
N/D | No |
hasBroker |
Indica se le entrate si basano sul netto. Il valore può essere uno dei seguenti:
|
N/D | No |
hasSelfBilling |
Indica che la monetizzazione deve generare una fattura con pagamento diretto anziché un prospetto della quota di condivisione delle entrate. Una fattura con autofatturazione è un documento finanziario che indica in dettaglio l'importo dovuto allo sviluppatore dell'app. Funge da fattura al fornitore di API per conto dello sviluppatore dell'app. Il valore può essere uno dei seguenti:
|
N/D | No |
hasSeparateInvoiceForProduct |
Indica se viene generata una fattura separata per ogni prodotto API. Il valore può essere uno dei seguenti:
|
N/D | No |
id |
ID dell'organizzazione. |
N/D | No |
issueNettingStmt |
Indica se viene generato un estratto conto di compensazione durante la creazione dei documenti di fatturazione. 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 di avviso di pagamento netto. |
N/D | No |
nettingStmtPerCurrency |
Indica se viene generato un estratto conto di compensazione separato per ogni valuta utilizzata. Il valore può essere uno dei seguenti:
|
N/D | No |
regNo |
Numero di registrazione dell'organizzazione. Il numero inserito per questa proprietà viene visualizzato nella parte inferiore dei documenti di fatturazione. |
N/D | No |
selfBillingAsExchOrg |
Se le fatture con autofatturazione sono attive, indica se sono attive per le organizzazioni di scambio. Il valore può essere uno dei seguenti:
|
N/D | No |
selfBillingForAllDev |
Se le fatture con fatturazione diretta sono attivate, indica se sono attivate per tutti gli 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 |
Indica se viene pubblicata una fattura separata per le commissioni. Il valore può essere uno dei seguenti:
|
falso | Sì |
status |
Stato dell'organizzazione. I valori validi includono:
|
N/D | No |
supportedBillingType |
Modello di pagamento dello sviluppatore utilizzato per la fatturazione. Il valore può essere uno dei seguenti:
Consulta Configurare i tipi di fatturazione prepagata e postpaid utilizzando l'API. |
PREPAID | Sì |
taxModel |
Nota:si applica solo se configuri piani tariffari con condivisione delle entrate e vuoi generare documenti di fatturazione. Modello fiscale per i piani tariffari con condivisione delle entrate che identifica il tipo di documenti di fatturazione richiesti. I valori validi includono:
|
N/D | Sì |
taxNexus |
Il paese in cui l'organizzazione è registrata ai fini fiscali. |
N/D | No |
taxRegNo |
Numero di registrazione fiscale dell'organizzazione o numero di registrazione 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/D | No |
transactionRelayURL |
URL di un altro sistema a cui possono essere inoltrate le transazioni, ad esempio un data warehouse. |
N/D | No |
timezone |
L'identificatore del fuso orario per le operazioni dell'organizzazione, ad esempio America/New_York o Europe/Paris. Sono supportate anche le abbreviazioni dei fusi orari, come UTC, EST (ora solare della costa orientale) o CET (ora centrale europea). |
N/D | Sì |
Sostituzione delle 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: