Gestisci il profilo dell'organizzazione

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X.
info

Le sezioni seguenti introducono il profilo dell'organizzazione e descrivono come gestirlo utilizzando la 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.

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 della 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 (prepagata, postpagata o entrambe), come descritto in Informazioni sul tipo di fatturazione
  • Ciclo di fatturazione (proporzionale o mensile)
  • Valuta di base
  • Modello fiscale utilizzato dalla tua organizzazione

Puoi gestire il profilo della tua organizzazione utilizzando la 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.

Edge

Per accedere alla pagina Profilo dell'organizzazione utilizzando l'interfaccia utente Edge:

  1. Accedi a apigee.com/edge.
  2. Seleziona Pubblica > 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 corrente
  • Modifica le impostazioni del profilo dell'organizzazione, tra cui:

Classic Edge (Private Cloud)

Per accedere alla pagina Profilo dell'organizzazione utilizzando l'interfaccia utente classica di Edge:

  1. Accedi a http://ms-ip:9000, dove ms-ip è l'indirizzo IP o il nome DNS del nodo del server di gestione.
  2. 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 corrente
  • Modifica le impostazioni del profilo dell'organizzazione, tra cui:

Modificare il profilo dell'organizzazione utilizzando la UI

Per modificare il profilo dell'organizzazione utilizzando l'interfaccia utente:

  1. Accedi alla pagina del profilo dell'organizzazione.
  2. Fai clic su Modifica.
  3. Nella sezione Nome e informazioni, modifica il nome dell'organizzazione e il paese di attività.
  4. Nella sezione Tasse e valuta, modifica i seguenti campi:
    Campo Descrizione
    Modello fiscale

    Nota:si applica solo se hai configurato piani tariffari di 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 di API agisce in qualità di agente comunicato dello sviluppatore. Le entrate lorde (incluse le imposte sulle vendite) riscosse dall'utente finale vengono trasferite allo sviluppatore. La commissione del fornitore dell'API viene riscossa dallo sviluppatore sotto forma di fattura di 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 divulgato: il fornitore dell'API funge da agente non divulgato dello sviluppatore, detrae l'imposta riscossa dagli utenti finali e la versa alle autorità fiscali locali. Lo sviluppatore fattura al fornitore di API la quota di entrate nette dovuta allo sviluppatore (al netto delle imposte sulle vendite e della commissione del fornitore di API).
    • Ibrido: il fornitore di API funge da agente dichiarato dello sviluppatore. Tuttavia, il fornitore dell'API versa alle autorità fiscali locali l'imposta sulle vendite riscossa dai suoi abbonati per conto dello sviluppatore. Il fornitore dell'API trasferisce le entrate rimanenti allo sviluppatore, quindi emette fattura per le commissioni.
    Valuta

    Valute supportate dalla tua organizzazione. Per i piani di condivisione delle entrate, tariffari e solo commissioni, la valuta predefinita viene utilizzata per il tuo piano tariffario. Quando crei una tariffa o un piano solo commissione, puoi cambiare la valuta da utilizzare selezionandola da un elenco di valute supportate. Se vuoi, 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:

    1. Fai clic su Aggiungi valuta.
    2. Seleziona una valuta dal menu a discesa nel campo Valuta.
    3. (Facoltativo) Imposta l'importo minimo che gli sviluppatori di app possono aggiungere al saldo del proprio account prepagato nella valuta specificata nel campo Ricarica minima.
    4. Fai clic su Aggiungi.
    5. Se vuoi, imposta la valuta come predefinita facendo clic sul pulsante di opzione associato.
    6. Ripeti i passaggi per aggiungere altre valute.

    Per eliminare una valuta, posiziona il cursore sopra la valuta che vuoi eliminare e fai clic su .

  5. Gestisci i termini e le condizioni, come descritto in Gestire i termini e le condizioni utilizzando la UI.
  6. 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 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 a USD e l'impostazione del modello fiscale a HYBRID (i campi aggiornati sono evidenziati nell'esempio). Per ulteriori informazioni sulle opzioni visualizzate, consulta 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 postpagata utilizzando l'API

Gli account sviluppatore possono essere configurati per utilizzare i seguenti tipi di fatturazione: prepagata, postpagata o entrambi.

Con i conti 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 acquistare le API.

Con gli account postpagati, gli sviluppatori ricevono una fattura mensile 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 postpagata 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 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

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 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, codice postale, 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:

  • RIPARTITO: 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.

Consulta Configurazione del ciclo di fatturazione utilizzando l'API.

N/D
country

Codice ISO 3166-2 per il paese di attività dell'organizzazione, ad esempio BR per il Brasile.

N/D
currency

Codice ISO 4217 per la valuta "base" o contabile utilizzata dall'organizzazione (ad esempio USD per il dollaro statunitense).

Per i piani di condivisione delle entrate: la valuta specificata viene utilizzata per il tuo piano.

Per i piani con tariffario (modello di addebito): vale lo stesso discorso dei piani di condivisione delle entrate. Tuttavia, puoi modificare l'impostazione della valuta in una qualsiasi valuta supportata dall'organizzazione.

Per i piani solo con commissioni: puoi modificare l'impostazione della valuta in qualsiasi valuta supportata dall'organizzazione.

N/D
description

Breve descrizione dell'organizzazione.

N/D No
hasBillingAdjustment

Flag che specifica se gli aggiustamenti sono attivati. Se abilitata, puoi apportare modifiche ai dettagli del traffico registrati da API Services per i tuoi prodotti API. Il valore può essere uno dei seguenti:

  • true: gli aggiustamenti sono attivi.
  • false: gli aggiustamenti non sono attivati.
N/D No
hasBroker

Flag che specifica se le entrate si basano sul valore netto. Il valore può essere uno dei seguenti:

  • true: Le entrate si basano sul netto.
  • false: Revenue is not based on net.
N/D No
hasSelfBilling

Flag che indirizza la monetizzazione alla generazione di una fattura di autofatturazione anziché di un estratto conto di condivisione delle entrate. Una fattura di autofatturazione è un documento finanziario che indica in dettaglio l'importo dovuto allo sviluppatore di app. Funge da fattura per il fornitore dell'API per conto dello sviluppatore di app. Il valore può essere uno dei seguenti:

  • true: genera fatture di autofatturazione anziché estratti della quota di condivisione delle entrate.
  • false: disabilita le autofatture.
N/D No
hasSeparateInvoiceForProduct

Flag che specifica se viene generata una fattura separata per ogni prodotto API. Il valore può essere uno dei seguenti:

  • true: viene generata una fattura separata per ogni prodotto API.
  • false: non viene generata una fattura separata per ogni prodotto API.
N/D No
id

ID dell'organizzazione.

N/D No
issueNettingStmt

Flag che specifica se viene generato un prospetto di compensazione durante la creazione dei documenti di fatturazione. Il valore può essere uno dei seguenti:

  • true: Il prospetto di compensazione viene generato durante la creazione dei documenti di fatturazione.
  • false: Il prospetto di compensazione non viene generato durante la creazione dei documenti di fatturazione.
N/D No
logoUrl

URL del logo dell'organizzazione.

N/D No
name

Nome dell'organizzazione.

N/D
netPaymentAdviceNote

Nota di consulenza sul pagamento netto.

N/D No
nettingStmtPerCurrency

Flag che specifica se viene generato un prospetto di compensazione separato per ogni valuta utilizzata. Il valore può essere uno dei seguenti:

  • true: viene generato un prospetto di compensazione separato per ogni valuta utilizzata.
  • false: non viene generato un estratto conto di compensazione separato per ogni valuta utilizzata.
N/D No
regNo

Numero di registrazione dell'organizzazione. Il numero inserito per questa proprietà viene visualizzato in fondo ai documenti di fatturazione.

N/D No
selfBillingAsExchOrg

Se sono attivate le fatture di autofatturazione, indica se l'opzione è attiva per le organizzazioni di scambio. Il valore può essere uno dei seguenti:

  • true: le fatture con addebito automatico sono attivate per le organizzazioni di scambio.
  • false: Le fatture di autofatturazione non sono abilitate per le organizzazioni di scambio.
N/D No
selfBillingForAllDev

Se sono attivate le fatture di autofatturazione, indica se sono attive 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 fornitore di API. Il valore può essere uno dei seguenti:

  • true: le fatture con addebito automatico sono attivate per tutti gli sviluppatori di app.
  • false: Le fatture di autofatturazione non sono attivate per tutti gli sviluppatori di app.
false No
separateInvoiceForFees

Flag che specifica se viene pubblicata una fattura separata per le tariffe. Il valore può essere uno dei seguenti:

  • true: Viene pubblicata una fattura separata per le commissioni.
  • false: Non viene pubblicata una fattura separata per le commissioni.
false
status

Stato dell'organizzazione. I valori validi includono:

  • ATTIVO: l'account dell'organizzazione è registrato per la monetizzazione ed è disponibile per l'uso.
  • INATTIVO: l'account dell'organizzazione è registrato per la monetizzazione, ma non è disponibile per l'utilizzo.
N/D No
supportedBillingType

Modello di pagamento dello sviluppatore utilizzato per la fatturazione. Il valore può essere uno dei seguenti:

  • PREPAGATO: lo sviluppatore paga in anticipo per l'utilizzo di un prodotto API. I fondi vengono detratti dal saldo dello sviluppatore quando viene utilizzato il prodotto API. Lo sviluppatore deve mantenere un saldo prepagato sufficiente per acquistare il prodotto API.
  • POSTPAID: lo sviluppatore riceve una fattura mensile per l'utilizzo dei prodotti API. Lo sviluppatore paga l'utilizzo dei prodotti basati su API in base ai termini di pagamento impostati dai piani inclusi nella fattura.
  • BOTH: supporta entrambi i tipi di fatturazione. Il valore predefinito è PREPAID.

Consulta la sezione Configurazione dei tipi di fatturazione prepagata e postpagata utilizzando l'API.

PREPAGATO
taxModel

Nota:si applica solo se hai configurato piani tariffari di 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 di API agisce in qualità di agente comunicato dello sviluppatore. Le entrate lorde (incluse le imposte sulle vendite) riscosse dall'utente finale vengono trasferite allo sviluppatore. La commissione del fornitore dell'API viene riscossa dallo sviluppatore sotto forma di fattura di 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 divulgato: il fornitore dell'API funge da agente non divulgato dello sviluppatore, detrae l'imposta riscossa dagli utenti finali e la versa alle autorità fiscali locali. Lo sviluppatore fattura al fornitore di API la quota di entrate nette dovuta allo sviluppatore (al netto delle imposte sulle vendite e della commissione del fornitore di API).
  • Ibrido: il fornitore di API funge da agente dichiarato dello sviluppatore. Tuttavia, il fornitore dell'API versa alle autorità fiscali locali l'imposta sulle vendite riscossa dai suoi abbonati per conto dello sviluppatore. Il fornitore dell'API trasferisce le entrate rimanenti allo sviluppatore, quindi emette fattura per le commissioni.
N/D
taxNexus

Il paese in cui l'organizzazione è registrata ai fini fiscali.

N/D No
taxRegNo

Numero di registrazione fiscale o numero di registrazione all'imposta sul valore aggiunto (IVA) dell'organizzazione, se applicabile. Questa proprietà è facoltativa perché il numero di registrazione fiscale o il numero di registrazione IVA non si applicano 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 (Eastern Standard Time) o CET (Central European Time).

N/D

Eseguire l'override delle impostazioni del profilo di monetizzazione per un'azienda o uno sviluppatore di app

Esegui l'override delle impostazioni del profilo di monetizzazione per una società o uno sviluppatore di app utilizzando la UI o l'API, come descritto nelle sezioni seguenti: