Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Un'organizzazione è il container di primo livello in Apigee Edge. Contiene tutti i proxy API e le risorse correlate. Il resto di questo argomento approfondisce le organizzazioni, ecco alcuni punti pratici:
- Per impostazione predefinita, il nome dell'organizzazione è incluso nell'URL utilizzato per chiamare i proxy API, come
descritto in Informazioni sugli host virtuali.
Ad esempio:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- Il nome dell'organizzazione è incluso nell'URL dell'interfaccia utente di gestione di Edge. Ad esempio, il seguente URL mostra i proxy API per l'organizzazione
docs:
- Anche se hai creato una sola organizzazione, puoi appartenere ad altre organizzazioni come utente o amministratore con autorizzazioni specifiche. Nell'interfaccia utente di gestione di Edge, se appartieni a più di un'organizzazione, puoi passare a un'altra organizzazione come descritto in Passare da un'organizzazione all'altra.
- Quando effettui chiamate con l'API di gestione come utente con il ruolo di amministratore dell'organizzazione
l'organizzazione è una parte obbligatoria del percorso nella maggior parte delle chiamate. Ad esempio, la seguente
richiesta cURL dell'API di gestione restituisce un elenco di tutti i proxy API in un'organizzazione:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
Video: guarda un breve video per scoprire in che modo le organizzazioni supportano un'architettura multi-tenant per la gestione delle API.
Componenti dell'organizzazione
Quando crei un account Edge, Edge crea automaticamente un'organizzazione per te. Una volta creata, puoi aggiungere utenti alla tua organizzazione, creare proxy API e prodotti API e registrare sviluppatori e app.
L'immagine seguente mostra i componenti principali del modello organizzativo di Edge. Questo modello definisce la relazione tra API, prodotti API, app e sviluppatori di app in Edge.
Questo modello non mostra tutte le funzionalità di Apigee Edge. Se utilizzi la monetizzazione, il modello avrà componenti aggiuntivi. Per ulteriori informazioni, consulta la sezione Panoramica della monetizzazione. Per informazioni sulla gestione di aziende e sviluppatori con la monetizzazione, consulta Gestire aziende e sviluppatori.
Nomi delle organizzazioni
Il nome dell'organizzazione è:
- Organizzazione di valutazione:
username-eval - Organizzazione a pagamento: definita dall'utente al momento del provisioning iniziale
Una volta creata, non puoi rinominare un'organizzazione.
Il nome dell'organizzazione diventa parte dell'URL dei proxy API e parte dell'URL quando effettui una richiesta all'API di gestione di Edge. Ad esempio, un URL tipico utilizzato per accedere a un proxy API ha il seguente formato:
http://org-name-env.apigee.net/v1/weather/forecastrss
dove:
- org-name è il nome della tua organizzazione.
- env è l'ambiente di deployment del proxy API, che è test o prod.
Ad esempio:
http://myorg-test.apigee.net/v1/weather/forecastrss
Componenti dell'organizzazione
La tabella seguente descrive i componenti del modello organizzativo in modo più dettagliato:
| Componente | Descrizione |
|---|---|
|
Organizzazione |
Ogni account Apigee esegue il mapping a una o più organizzazioni su Apigee Edge. L' organizzazione contiene una rappresentazione di tutti i componenti, inclusi proxy API, prodotti API, pacchetti API, app e sviluppatori. I titolari degli account non sono limitati a una singola organizzazione. Alcuni titolari di account potrebbero definire o essere membri di più organizzazioni che supportano diverse community di sviluppatori di app. |
| Ambiente | Un contesto di esecuzione in fase di runtime per i proxy API in un'organizzazione. Per ulteriori informazioni sugli ambienti, consulta la sezione seguente. |
|
Utente |
All'interno di un'organizzazione, in cui la persona che crea l'account è automaticamente un amministratore, puoi creare altri utenti. Gli utenti compongono il team API dell'organizzazione, che può includere persone come amministratori, creatori di proxy API e prodotti API, utenti che monitorano analisi e altre statistiche e altri utenti. Utenti diversi possono avere ruoli e privilegi di accesso diversi. Ad esempio, definisci alcuni utenti come amministratori dell'organizzazione e amministratori delle operazioni con i privilegi per modificare l'organizzazione e i relativi componenti. Definisci altri utenti con le autorizzazioni per creare proxy API e prodotti API, ma senza i privilegi per modificare altri utenti. Gli utenti possono essere membri di più organizzazioni. Ad esempio, la tua azienda potrebbe definire più organizzazioni su Apigee Edge per supportare diverse community di sviluppatori. A livello interno, tuttavia, le stesse persone creano tutti i proxy API e i prodotti API e sono quindi membri di tutte le tue organizzazioni. Non devi creare un account Apigee, ovvero un'organizzazione Apigee, per essere un utente. Un amministratore può aggiungerti a un'organizzazione esistente. Tutti gli utenti accedono ad Apigee Edge qui: https://enterprise.apigee.com. |
|
Proxy API |
Gli utenti di un'organizzazione creano uno o più proxy API. Un proxy API definisce un mapping di un endpoint HTTP disponibile pubblicamente a un servizio di backend. I proxy API possono anche essere configurati per includere la sicurezza (ad esempio OAuth), eseguire la trasformazione dei messaggi (ad esempio da XML a JSON), limitare il traffico ai servizi di backend ed eseguire altre operazioni utili sulla richiesta, sulla risposta e con i callout di servizio. Edge raccoglie dati per l'analisi dei proxy API. |
|
Prodotto API |
Gli utenti di un'organizzazione creano uno o più prodotti API, dove un prodotto API è un pacchetto di proxy API combinato con un piano di servizi. Questo piano di servizi può impostare limiti di accesso ai proxy API, fornire sicurezza, consentire il monitoraggio e l'analisi e fornire funzionalità aggiuntive. Edge raccoglie dati per l'analisi dei prodotti API. |
|
Sviluppatore |
Un'organizzazione contiene uno o più sviluppatori che creano le app che utilizzano le API (assemblate in prodotti API) definite dalla tua organizzazione. Gli sviluppatori utilizzano le API , ma non possono crearle o eseguire altre azioni nell'organizzazione. Gli sviluppatori possono essere interni alla tua azienda, possono essere partner o essere sviluppatori esterni che pagano per l'accesso alle tue API. Gli sviluppatori devono essere registrati nella tua organizzazione prima di poter registrare un'app e ricevere una chiave API per accedere alle tue API. In qualità di fornitore di API, spetta a te determinare come aggiungere, aggiornare o rimuovere gli sviluppatori nella tua organizzazione. Puoi aggiungerli manualmente tramite l'interfaccia utente di gestione di Edge, creare un portale per sviluppatori per registrarli tramite un sito web o definire il tuo meccanismo di registrazione utilizzando l'API di gestione di Edge. Uno sviluppatore non è tenuto ad avere un account su Edge e la maggior parte degli sviluppatori non avrà bisogno di sapere nulla di Edge. Se lo sviluppatore ha un account su Edge, in genere è come utente in un'altra organizzazione o per utilizzare i servizi API di Edge. |
|
App |
Gli sviluppatori creano una o più app client che utilizzano le tue API. Gli sviluppatori devono registrare le proprie app presso la tua organizzazione. Un'app in Edge è una rappresentazione dell'app effettiva di uno sviluppatore che fornisce allo sviluppatore una chiave API da passare con ogni richiesta alle tue API. Poiché tutte le app sono registrate nella tua organizzazione, puoi utilizzare Edge per monitorare e raccogliere informazioni analitiche sull'app e sul suo utilizzo delle tue API. |
|
Chiave API/token OAuth |
A seconda del meccanismo di autorizzazione definito per le tue API, l'app passa una chiave API insieme a ogni richiesta alle tue API. Se la chiave è valida, la richiesta è consentita. Edge supporta diversi tipi di autenticazione, come una semplice chiave API, OAuth a due vie, OAuth a tre vie e altri. In qualità di fornitore di API, devi definire un modo in cui gli sviluppatori possano registrare le proprie app. Registrando la propria app, restituisci allo sviluppatore la chiave necessaria per accedere alle tue API. Al momento della registrazione dell'app, lo sviluppatore può scegliere di accedere a un singolo prodotto API o a più prodotti API. L'app effettiva dello sviluppatore utilizza la stessa chiave per accedere a tutti i prodotti API associati all'app (la rappresentazione registrata dell' app dello sviluppatore in Edge). In qualsiasi momento, puoi revocare la chiave in modo che l'app dello sviluppatore non abbia più accesso alle tue API (anche se la rappresentazione registrata dell'app dello sviluppatore esiste ancora nella tua organizzazione). In alternativa, puoi definire un limite di tempo per una chiave in modo che lo sviluppatore debba aggiornarla dopo un periodo di tempo specifico. |
Informazioni sugli ambienti
Un ambiente è un contesto di esecuzione in fase di runtime per i proxy API in un'organizzazione. Prima di poter accedere a un proxy API, devi eseguirne il deployment in un ambiente. Puoi eseguire il deployment di un proxy API in un singolo ambiente o in più ambienti.
Un'organizzazione può contenere più ambienti. Ad esempio, potresti definire un ambiente dev,
test, e prod in un'organizzazione.
L'organizzazione fornisce l'ambito per alcune funzionalità di Apigee. Ad esempio, i dati della mappa chiave-valore (KVM) possono essere resi disponibili a livello di organizzazione, il che significa che i proxy API di cui è stato eseguito il deployment in qualsiasi ambiente riceverebbero gli stessi dati da KVM. Alcune funzionalità, come la memorizzazione nella cache, possono essere limitate all'organizzazione o a un ambiente specifico all'interno dell'organizzazione. I dati di analisi di Apigee sono partizionati in base a una combinazione di organizzazione e ambiente.
Di seguito sono riportate le principali entità che gestisci all'interno di un'organizzazione, incluse quelle definite a livello globale nell'organizzazione e quelle definite specificamente per un ambiente:
