Informationen zu Organisationen

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

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 Organisationsname 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 Aufrufe mit der Management API als Nutzer mit der Rolle des Organisationsadministrators ausführen, ist die Organisation bei den meisten Aufrufen ein erforderlicher Teil des Pfads. Die folgende cURL-Anfrage für die Verwaltungs-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: In einem kurzen Video erfahren Sie, 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 dem Erstellen können Sie Ihrer Organisation Nutzer hinzufügen, API-Proxys und API-Produkte erstellen sowie Entwickler und Apps registrieren.

Die folgende Abbildung zeigt die Hauptkomponenten des Edge-Organisationsmodells. Dieses Modell definiert, wie Ihre APIs, API-Produkte, Apps und App-Entwickler innerhalb von Edge zusammenhängen.

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

Dieses Modell zeigt nicht alle Features von Apigee Edge. Wenn Sie die Monetarisierung nutzen, hat das Modell zusätzliche Komponenten. Weitere Informationen findest du unter Monetarisierung. Weitere Informationen zur Monetarisierung von Unternehmen und Entwicklern finden Sie unter Unternehmen und Entwickler verwalten.

Namen der Organisation

Der Name der Organisation lautet:

  • Bewertungsorganisation: username-eval
  • Kostenpflichtige Organisation:bei der ersten Bereitstellung vom Nutzer definiert

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

Der Organisationsname wird Teil der URL zu Ihren API-Proxys und Teil der URL, wenn eine Anfrage an die Edge Management API gesendet wird. Eine typische URL, die für den Zugriff auf einen API-Proxy verwendet wird, 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 Produktion.

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 ist einer oder mehreren Organisationen in Apigee Edge zugeordnet. Die Organisation enthält eine Darstellung aller Komponenten, einschließlich API-Proxys, API-Produkten, API-Paketen, Anwendungen und Entwicklern.

Kontoinhaber sind nicht auf eine einzelne Organisation beschränkt. Einige Kontoinhaber definieren oder definieren mehrere Organisationen, die unterschiedliche Communities 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. Definieren Sie beispielsweise einige Nutzer als 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, aber ohne die Berechtigungen zum Ändern anderer Nutzer.

Nutzer können Mitglieder mehrerer Organisationen sein. Beispielsweise könnte Ihr Unternehmen mehrere Organisationen in Apigee Edge definieren, um verschiedene Entwickler-Communities zu unterstützen. Allerdings erstellen intern dieselben Personen alle API-Proxys und API-Produkte und sind daher Mitglieder aller Ihrer Organisationen.

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

Alle Benutzer melden sich hier bei 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 Back-End-Dienst. API-Proxys können auch so konfiguriert werden, dass sie Sicherheit (z. B. OAuth), Nachrichtentransformation (z. B. von XML zu JSON), den Traffic auf Back-End-Dienste begrenzen und andere wertvolle Vorgänge für die Anfrage, die Antwort und mit Dienst-Callouts ausführen.

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 dabei ein Bundle von API-Proxys, die mit einem Dienstplan kombiniert sind. Dieser Dienstplan kann Zugriffsbeschränkungen für API-Proxys festlegen, Sicherheit bieten, Monitoring und Analysen zulassen und zusätzliche Features bereitstellen.

Edge sammelt Daten für Analysen von API-Produkten.

Developer

Eine Organisation hat einen oder mehrere Entwickler, die die Anwendungen erstellen, die die in Ihrer Organisation definierten APIs (in API-Produkten) nutzen. 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-Anbieter können Sie Entwickler in Ihrer Organisation hinzufügen, aktualisieren oder entfernen. Sie können sie manuell über die Edge-Management-UI hinzufügen, ein Entwicklerportal erstellen, um sie über eine Website zu registrieren, oder mit der Edge Management API einen eigenen Registrierungsmechanismus definieren.

Entwickler benötigen kein Konto bei Edge und die meisten Entwickler müssen nichts über Edge wissen. Wenn der Entwickler ein Konto in Edge hat, erfolgt dies in der Regel als Nutzer in einer anderen Organisation oder zur Verwendung der Edge API-Dienste.

App

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, die dem Entwickler einen API-Schlüssel bereitstellt, der bei jeder Anforderung an Ihre APIs übergeben werden muss.

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

Abhängig vom Autorisierungsmechanismus, den Sie für Ihre APIs definieren, übergibt die Anwendung zusammen mit jeder Anfrage einen API-Schlüssel an Ihre APIs. Wenn der Schlüssel gültig ist, ist die Anfrage zulässig. Edge unterstützt verschiedene Arten der Authentifizierung, z. B. einen einfachen API-Schlüssel, zweibeiniges OAuth und dreibeiniges OAuth.

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 Kontext der Laufzeitausführung 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. Sie können beispielsweise eine dev-, test- und prod-Umgebung in einer Organisation definieren.

Organisation bietet Umfang für einige Apigee-Funktionen. Beispielsweise können KVM-Daten (Key-Wert-Map) auf Organisationsebene verfügbar gemacht werden. Das bedeutet, dass API-Proxys, die in einer beliebigen Umgebung bereitgestellt werden, dieselben Daten von KVM erhalten. Einige Funktionen, z. B. das Caching, können auf die Organisation oder eine bestimmte Umgebung innerhalb der Organisation beschränkt werden. Apigee-Analysedaten werden nach einer Kombination aus Organisation und Umgebung partitioniert.

Im Folgenden sind die wichtigsten Entitäten aufgeführt, die Sie in einer Organisation verwalten. Dazu gehören sowohl die global in der Organisation als auch die speziell für eine Umgebung definierten: