Informationen zu Organisationen

Sie lesen gerade die Apigee Edge-Dokumentation.
Zur Apigee X-Dokumentation.
info

Eine Organisation ist der übergeordnete Container in Apigee Edge. Sie enthält alle Ihre API-Proxys und die zugehörigen Ressourcen. Im weiteren Verlauf dieses Themas werden Organisationen ausführlicher behandelt. Hier ein paar nützliche Hinweise:

  • Standardmäßig ist der Name Ihrer Organisation in der URL enthalten, die zum Aufrufen Ihrer API-Proxys verwendet wird, wie unter Informationen zu virtuellen Hosts beschrieben. Beispiel:
    http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
  • Der Name Ihrer Organisation befindet sich in der URL der Edge-Verwaltungs-UI. Die folgende URL zeigt beispielsweise die API-Proxys für die Organisation docs an:

    In der URL „apigee.com/organizations/docs/proxies“ ist „/docs/“ eingekreist.

  • Sie haben zwar nur eine Organisation erstellt, können aber zu anderen Organisationen als Nutzer oder Administrator mit bestimmten Berechtigungen gehören. Wenn Sie in der Edge-Verwaltungs-UI zu mehr als einer Organisation gehören, können Sie zu einer anderen Organisation wechseln, wie unter Zwischen Organisationen wechseln beschrieben.

  • Wenn Sie als Nutzer mit der Rolle „Organisationsadministrator“ Aufrufe mit der Management API ausführen, ist die Organisation bei den meisten Aufrufen ein erforderlicher Teil des Pfads. Die folgende cURL-Anfrage der Management API gibt beispielsweise eine Liste aller API-Proxys in einer Organisation zurück:
    curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address

Video: Sehen Sie sich ein Kurzvideo an, um zu erfahren, wie Organisationen eine mandantenfähige Architektur für die API-Verwaltung unterstützen.

Organisationskomponenten

Wenn Sie ein Edge-Konto erstellen, erstellt Edge automatisch eine Organisation für Sie. Nach der Erstellung können Sie Nutzer zu Ihrer Organisation hinzufügen, API-Proxys und API-Produkte erstellen sowie Entwickler und Apps registrieren.

Die folgende Abbildung zeigt die wichtigsten Komponenten des Edge-Organisationsmodells. Dieses Modell definiert, wie Ihre APIs, API-Produkte, Anwendungen und Anwendungsentwickler innerhalb von Edge miteinander verknüpft sind.

Ein Flussdiagramm zeigt, wie die Umgebung, der Nutzer, das API-Produkt und der Entwickler mit der App, dem API-Schlüssel/OAuth-Token und dem API-Proxy zusammenhängen.

Dieses Modell zeigt nicht alle Funktionen von Apigee Edge. Wenn Sie die Monetarisierung verwenden, enthält das Modell zusätzliche Komponenten. Weitere Informationen finden Sie unter Übersicht über die Monetarisierung. Informationen zum Verwalten von Unternehmen und Entwicklern mit der Monetarisierung finden Sie unter Unternehmen und Entwickler verwalten.

Organisationsnamen

Der Name der Organisation ist:

  • Evaluierungsorganisation:username-eval
  • Kostenpflichtige Organisation:Vom Nutzer bei der ersten Bereitstellung definiert

Nachdem eine Organisation erstellt wurde, können Sie sie nicht mehr umbenennen.

Der Name der Organisation wird Teil der URL zu Ihren API-Proxys und Teil der URL, wenn Sie eine Anfrage an die Edge Management API senden. Eine typische URL für den Zugriff auf einen API Proxy hat beispielsweise folgendes Format:

http://org-name-env.apigee.net/v1/weather/forecastrss

Dabei gilt:

  • org-name ist der Name Ihrer Organisation.
  • env ist die Bereitstellungsumgebung des API-Proxys, entweder „test“ oder „prod“.

Beispiel:

http://myorg-test.apigee.net/v1/weather/forecastrss

Organisationskomponenten

In der folgenden Tabelle werden die Komponenten des Organisationsmodells näher beschrieben:

Komponente Beschreibung

Organisation

Jedes Apigee-Konto wird einer oder mehreren Organisationen in Apigee Edge zugeordnet. Die Organisation enthält eine Darstellung aller Komponenten, einschließlich API-Proxys, API Produkte, API-Pakete, Anwendungen und Entwickler.

Kontoinhaber sind nicht auf eine einzelne Organisation beschränkt. Einige Kontoinhaber definieren oder sind Mitglied mehrerer Organisationen, die unterschiedliche Communitys für App-Entwickler unterstützen.

Umgebung Ein Laufzeitkontext für die API-Proxys in einer Organisation. Weitere Informationen zu Umgebungen finden Sie im folgenden Abschnitt.

Nutzer

Innerhalb einer Organisation, in der die Person, die das Konto erstellt, automatisch ein Administrator ist, können Sie weitere Nutzer erstellen. Nutzer bilden das API-Team der Organisation, z. B. Administratoren, API-Proxy und API-Produktersteller, Nutzer, die Analysen und andere Statistiken überwachen usw.

Unterschiedliche Nutzer haben unterschiedliche Rollen und Zugriffsberechtigungen. Beispiel: Manche Nutzer sind Organisationsadministratoren und Betriebsadministratoren mit Berechtigungen zum Ändern der Organisation und ihrer Komponenten. Definieren Sie andere Nutzer mit Berechtigungen zum Erstellen von API-Proxys und API-Produkten, jedoch ohne die Berechtigung, andere Nutzer zu ändern.

Nutzer können Mitglieder mehrerer Organisationen sein. Beispielsweise könnte Ihr Unternehmen mehrere Organisationen in Apigee Edge definieren, um verschiedene Entwickler-Communitys zu unterstützen. Intern werden dieselben API-Proxys und API-Produkte intern erstellt und sind daher Mitglieder Ihrer Organisation.

Sie müssen kein Apigee-Konto erstellen, d. h. keine Apigee Organisation erstellen, um Nutzer zu sein. Ein Administrator kann Sie einer vorhandenen Organisation hinzufügen.

Alle Nutzer melden sich hier in Apigee Edge an: https://enterprise.apigee.com.

API-Proxy

Die Nutzer in einer Organisation erstellen einen oder mehrere API-Proxys. Ein API-Proxy definiert eine Zuordnung eines öffentlich verfügbaren HTTP-Endpunkts zu einem Backend-Dienst. API-Proxys können auch so konfiguriert werden, dass sie die Sicherheit enthalten (z. B. OAuth), eine Nachrichtentransformation (z. B. von XML zu JSON), eine Beschränkung des Traffics auf Back-End-Dienste und andere nützliche Vorgänge für Anfragen und Antworten, inklusive Service-Callouts.

Edge erfasst Daten für Analysen zu API-Proxys.

API-Produkt

Die Nutzer in einer Organisation erstellen ein oder mehrere API-Produkte. Ein API-Produkt ist ein Paket mit API-Proxys in Kombination mit einem Serviceplan. Dieser Serviceplan kann Zugriffsbeschränkungen für API-Proxys festlegen, Sicherheit gewährleisten, Monitoring und Analysen ermöglichen sowie zusätzliche Funktionen bereitstellen.

Edge erfasst Daten für die Analyse von API-Produkten.

Entwickler

Eine Organisation hat einen oder mehrere Entwickler, die die Anwendungen erstellen, die die APIs (in API-Produkten) nutzen, die von Ihrer Organisation definiert wurden. Entwickler nutzen APIs, können jedoch keine APIs erstellen oder andere Aktionen in der Organisation ausführen.

Entwickler können zu Ihrem Unternehmen gehören, Partner oder externe Entwickler sein, die für den Zugriff auf Ihre APIs bezahlen.

Entwickler müssen in Ihrer Organisation registriert sein, bevor sie eine App registrieren und einen API-Schlüssel für den Zugriff auf Ihre APIs erhalten können. Als API-Bereitsteller können Sie Entwickler in Ihrer Organisation hinzufügen, aktualisieren oder entfernen. Sie können sie manuell über die Edge-Verwaltungs-UI hinzufügen, ein Entwicklerportal erstellen, um sie über eine Website zu registrieren, oder einen eigenen Registrierungsmechanismus mithilfe der Edge Management API definieren.

Ein Entwickler muss kein Konto in Edge haben und die meisten Entwickler müssen nichts über Edge wissen. Wenn der Entwickler ein Konto in Edge hat, ist er in der Regel ein Nutzer in einer anderen Organisation oder verwendet die Edge API-Dienste.

Anwendung

Entwickler erstellen eine oder mehrere Clientanwendungen, die Ihre APIs nutzen.

Entwickler müssen ihre Anwendungen in Ihrer Organisation registrieren. Eine Anwendung in Edge ist eine Darstellung der tatsächlichen Anwendung eines Entwicklers. Der Entwickler enthält mit dieser Anwendung einen API-Schlüssel, der mit jeder Anfrage an Ihre APIs übergeben wird.

Da alle Apps in Ihrer Organisation registriert sind, können Sie mithilfe von Edge Analysedaten zur App und deren Nutzung überwachen und erfassen.

API-Schlüssel/OAuth-Token

Je nachdem, welchen Autorisierungsmechanismus Sie für Ihre APIs definieren, übergibt die App bei jeder Anfrage an Ihre APIs einen API-Schlüssel. Wenn der Schlüssel gültig ist, ist die Anfrage zulässig. Edge unterstützt verschiedene Authentifizierungsmethoden wie einen einfachen API-Schlüssel, zweibeiniges OAuth, dreibeiniges OAuth und andere.

Als API-Anbieter müssen Sie festlegen, wie Entwickler ihre Apps registrieren. Dazu wird die App registriert, die Sie an den Entwickler zurückgeben, um den Schlüssel für den Zugriff auf Ihre APIs zu erhalten.

Bei der Registrierung der App kann der Entwickler auf ein einzelnes API-Produkt oder auf mehrere API-Produkte zugreifen. Die tatsächliche App des Entwicklers verwendet für den Zugriff auf alle API-Produkte, die mit der App verknüpft sind (die registrierte Darstellung der App des Entwicklers in Edge).

Sie können den Schlüssel jederzeit widerrufen, sodass die Anwendung des Entwicklers nicht mehr auf Ihre APIs zugreifen kann . Die registrierte Darstellung der Anwendung des Entwicklers ist jedoch weiterhin in Ihrer Organisation vorhanden . Alternativ können Sie ein Zeitlimit für einen Schlüssel definieren, sodass der Entwickler den Schlüssel nach einer bestimmten Zeit aktualisieren muss.

Informationen zu Umgebungen

Eine Umgebung ist ein Laufzeitkontext für die API-Proxys in einer Organisation. Bevor Sie auf einen API-Proxy zugreifen können, müssen Sie ihn in einer Umgebung bereitstellen. Sie können einen API Proxy in einer einzelnen Umgebung oder in mehreren Umgebungen bereitstellen.

Eine Organisation kann mehrere Umgebungen enthalten. Beispielsweise können Sie in einer Organisation eine dev, test, und prod Umgebung definieren.

Die Organisation bietet einen Bereich für einige Apigee-Funktionen. Beispielsweise stehen Daten für die Schlüssel/Wert-Paar-Zuordnung (KVM) auf Organisationsebene zur Verfügung. Das bedeutet, dass API-Proxys, die in einer beliebigen Umgebung bereitgestellt werden, dieselben Daten aus der KVM erhalten. Einige Funktionen wie das Caching können auf die Organisation oder auf eine bestimmte Umgebung innerhalb der Organisation beschränkt werden. Apigee-Analysedaten werden durch eine Kombination aus Organisation und Umgebung partitioniert.

Unten sind die wichtigsten Entitäten aufgeführt, die Sie in einer Organisation verwalten, einschließlich der global in der Organisation definierten und der speziell für eine Umgebung definierten Entitäten: