Zugriff auf APIs durch Registrierung von Anwendungen steuern

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

In diesem Abschnitt wird beschrieben, wie Sie Anwendungen registrieren und API-Schlüssel verwalten.

Übersicht

Die Hauptmethode zum Steuern des Zugriffs auf APIs ist die Anwendungsregistrierung.

Als API-Anbieter erstellen Sie ein oder mehrere API-Produkte, in denen Ihre APIs zu Dienststufen zusammengefasst sind. Mit API-Produkten können Sie den Traffic und die Zugriffsebenen auf sehr detaillierten Ebenen einschränken. Wenn Sie ein API-Produkt erstellen, können Sie die Zugriffsebene auf "Öffentlich", "Privat" oder "Intern" festlegen. Weitere Informationen finden Sie unter Zugriffsebene.

Bei der Registrierung einer Anwendung wählt der App-Entwickler die zu verwendenden API-Produkte aus. Apigee stellt dann einen einzigen API-Schlüssel bereit, mit dem der Entwickler auf diese API-Produkte zugreifen kann. Der App-Entwickler übergibt den API-Schlüssel bei jedem Aufruf an die in den API-Produkten enthaltenen API-Proxys. Sie können den API-Schlüssel einer App jederzeit widerrufen, sodass ein App-Entwickler nicht auf alle oder einen Teil der API-Produkte zugreifen kann, auf die von dieser App verwiesen wird.

Diagramm eines Entwicklers mit drei Anwendungen.

In der Regel registrieren sich App-Entwickler, damit sie Ihre API-Produkte mithilfe Ihres Entwicklerportals nutzen können. Die Schritte zum Erstellen Ihres Portals sowie zum Veröffentlichen Ihrer API-Produkte werden unter Portal erstellen beschrieben.

Sie können die Anwendungsregistrierung besser steuern, indem Sie Ihre Anwendungen stattdessen über die Apigee-UI oder die Apigee API registrieren. Beispielsweise können Sie Apps für Ihre internen Entwicklungsteams oder für einen Entwickler registrieren, der nicht auf Ihr Portal zugreifen kann.

In den folgenden Abschnitten wird beschrieben, wie Sie Apps mithilfe der Benutzeroberfläche und der API registrieren und API-Schlüssel verwalten.

Apps-Seite entdecken

Zum Registrieren von Apps und zum Verwalten von API-Schlüsseln in der Apigee-UI verwenden Sie die Ansicht Apps.

So greifen Sie über die Apigee-Benutzeroberfläche auf die Seite Apps zu:

In der Ansicht Anwendungen können Sie Folgendes tun:

Eine App registrieren

So kann eine App registriert werden:

  • Von einem App-Entwickler: Ein App-Entwickler kann die App über Ihr Portal registrieren. Dies wird unter Interaktion von App-Entwicklern mit Ihrem Portal beschrieben.
  • Von einem Administrator: Sie können eine Anwendung wie unten beschrieben in Apigee registrieren. Sie müssen selbst entscheiden, wie Sie den Schlüssel dem App-Entwickler bereitstellen.

Registrierte Anwendungen werden folgendermaßen hinzugefügt:

So registrieren Sie eine Anwendung in Apigee:

  1. Seite „Apps“ aufrufen.
  2. Legen Sie die App-Details wie in der folgenden Tabelle angegeben fest:
    Feld Beschreibung erforderlich?
    Name Name der App. Sobald die App erstellt ist, können Sie den Namen nicht mehr ändern. Dieser Name wird in Apigee API-Aufrufen verwendet. Erforderlich
    Anzeigename Anzeigename für die App, die in der Apigee-Benutzeroberfläche und im Entwicklerportal angezeigt wird. Optional
    Entwickler

    Wählen Sie einen Entwicklernamen aus dem Drop-down-Menü aus.

    Hinweis: Aus Leistungsgründen werden nicht alle Entwickler im Drop-down-Menü angezeigt. Geben Sie den Namen des Entwicklers oder die E-Mail-Adresse in das Suchfeld ein. Die Drop-down-Werte werden automatisch entsprechend dem von Ihnen eingegebenen Text angepasst. Siehe auch App-Entwickler registrieren

    		 Erforderlich
    Rückruf-URL Gibt in der Regel die URL einer Anwendung an, die für den Empfang eines Autorisierungscodes im Namen der Client-App bestimmt ist. Dieser Wert ist nicht für alle API-Produkte erforderlich. Optional
    Hinweise Beschreibende Hinweise für die Anwendung. Optional
  3. Geben Sie die Anmeldedaten an, einschließlich des Ablaufs und Status des API-Schlüssels sowie der zugehörigen API-Produkte. Klicken Sie im Bereich Anmeldedaten auf und geben Sie die folgenden Informationen ein:
    Feld Beschreibung
    Ablaufdatum Konfigurieren Sie eine Ablaufzeit oder ein Datum oder richten Sie den API-Schlüssel so ein, dass er nie abläuft, und klicken Sie auf OK.
    Produkte Verknüpfen Sie ein oder mehrere API-Produkte mit dem API-Schlüssel:
    1. Klicken Sie auf Produkt hinzufügen.
    2. Wählen Sie ein oder mehrere API-Produkte aus der Liste aus.
    3. Klicken Sie auf Add.
    4. Legen Sie den Status für jedes API-Produkt auf "Genehmigt" oder "widerrufen" fest.
    5. Wiederholen Sie diese Schritte, um weitere API-Produkte hinzuzufügen.
  4. Geben Sie die benutzerdefinierten Attribute an:
    1. Klicken Sie im Bereich „Benutzerdefinierte Attribute“ auf .
    2. Geben Sie den Namen und den Wert ein.
    3. Klicken Sie auf Hinzufügen oder Weitere hinzufügen und starten. Es können maximal 18 benutzerdefinierte Attribute hinzugefügt werden.
  5. Klicken Sie auf Erstellen.

Wenn die mit der App verknüpften API-Produkte eine manuelle Genehmigung für ihre API-Schlüssel erfordern, müssen Sie diese genehmigen, wie unter API-Schlüssel genehmigen oder widerrufen beschrieben.

Für einen Entwickler registrierte Apps ansehen

Um Apps aufzurufen, die für einen bestimmten Entwickler registriert sind, verwenden Sie eine der folgenden Methoden:

Ansehen und Bearbeiten einer Anwendung

So rufen Sie eine App auf und bearbeiten sie:

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie auf eine beliebige Stelle in der Zeile der App, die Sie aufrufen und bearbeiten möchten. Apigee zeigt die Anwendungsdetails an.
  3. Klicken Sie zum Bearbeiten einer App auf Bearbeiten.
  4. Führen Sie eine oder mehrere der folgenden Aufgaben aus:
  5. Klicken Sie auf Speichern.

Anmeldedaten verwalten

Wenn Sie eine Anwendung bearbeiten, können Sie die Anmeldedaten im Abschnitt Anmeldedaten verwalten, wie in der folgenden Abbildung dargestellt:

Diagramm des Anmeldedatenbereichs.

Wie in der vorherigen Abbildung hervorgehoben, können Sie im Bereich „Anmeldedaten“ die folgenden Aufgaben über die UI ausführen:

Wie Sie Anmeldedaten mit der API verwalten, erfahren Sie unter Vorhandene Consumer-Keys und Secrets importieren.

API-Schlüssel und Secret aufrufen

So zeigen Sie einen API-Schlüssel und ein Secret an:

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie in die Zeile der App, für die Sie den API-Schlüssel und das Secret aufrufen möchten.
  3. Klicken Sie im Bereich „Anmeldedaten“ für den API-Schlüssel oder das Secret, das Sie ansehen möchten, auf Anzeigen.

API-Schlüssel genehmigen oder widerrufen

API-Aufrufe an API-Proxys erfordern in der Regel einen API-Schlüssel. Apigee lässt die Aufrufe nur zu, wenn der API-Schlüssel genehmigt, gültig und den Bedingungen des API-Produkts entspricht, in dem die API enthalten ist.

Sie können ein API-Produkt für die automatische Genehmigung von API-Schlüsseln konfigurieren, wie unter API-Produkte verwalten beschrieben. Falls das API-Produkt jedoch eine manuelle Genehmigung von API-Schlüsseln erfordert, müssen Sie den Schlüssel manuell genehmigen.

Sie können einen API-Schlüssel für alle oder ein einzelnes API-Produkt widerrufen. Der API-Schlüssel und das Secret sind in diesem Fall ungültig und können nicht für den Zugriff auf APIs in den zugehörigen API-Produkten verwendet werden. Sie können einen API-Schlüssel jederzeit neu genehmigen.

So genehmigen oder widerrufen Sie einen API-Schlüssel:

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie in die Zeile der App, die Sie aufrufen und bearbeiten möchten.
  3. Klicken Sie auf Bearbeiten.
  4. Führen Sie eine der folgenden Aufgaben aus:
    • Um einen API-Schlüssel für alle API-Produkte, die einem API-Schlüssel zugeordnet sind, zu genehmigen oder zu widerrufen, wählen Sie Genehmigt oder Widerrufen für den API-Schlüssel aus.
    • Wenn Sie einen API-Schlüssel für ein bestimmtes API-Produkt genehmigen oder widerrufen möchten, wählen Sie für das API-Produkt in der Spalte „Status“ Genehmigt oder Widerrufen aus.
  5. Klicken Sie auf Speichern.

API-Produkte in einer App verwalten

So verwalten Sie API-Produkte in Ihrer App:

API-Produkt zu einer Anwendung hinzufügen

So fügen Sie ein API-Produkt zu einer Anwendung hinzu:

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie in die Zeile der App, die Sie aufrufen und bearbeiten möchten.
  3. Klicken Sie auf Bearbeiten.
  4. Führen Sie eine der folgenden Aufgaben aus:
    • Wenn Sie einem neuen API-Schlüssel ein API-Produkt hinzufügen möchten, klicken Sie auf , um neue Anmeldedaten zu generieren, einen Ablauf auszuwählen und das API-Produkt dem API-Schlüssel hinzuzufügen.
    • Wenn Sie einem vorhandenen API-Schlüssel ein API-Produkt hinzufügen möchten, klicken Sie im Abschnitt „Anmeldedaten“ auf Produkt hinzufügen und wählen Sie in der Drop-down-Liste das API-Produkt aus.
  5. Klicken Sie auf Speichern.

API-Produkt aus einer App entfernen

Wenn Sie einen API-Schlüssel aktiv lassen möchten, er aber nicht von einem API-Produkt verwendet werden soll, können Sie ihn aus den entsprechenden Anmeldedaten entfernen.

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie in die Zeile der App, die Sie aufrufen und bearbeiten möchten.
  3. Klicken Sie auf Bearbeiten.
  4. Klicken Sie neben dem API-Produkt auf .
  5. Klicken Sie auf Speichern.

Entfernte Produkte können wieder hinzugefügt werden.

Neue Anmeldedaten generieren

Sie können neue Anmeldedaten für eine Anwendung generieren. Wenn Sie beispielsweise die API-Schlüsselrotation verwenden, können Sie neue Schlüssel generieren, deren Ablauf sich mit dem Ablauf von Schlüsseln überschneidet, die nach Ablauf nicht mehr in der Rotation sein werden. Sie können auch ein neues Schlüssel/Secret generieren, wenn die Sicherheit des ursprünglichen Schlüssels bzw. des alten Secrets gefährdet ist. Falls Sie einen neuen Schlüssel generieren, funktionieren vorhandene API-Schlüssel so lange, bis sie ablaufen oder Sie diese explizit widerrufen.

So generieren Sie einen neuen API-Schlüssel:

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie in die Zeile der App, die Sie aufrufen und bearbeiten möchten.
  3. Klicken Sie auf Bearbeiten.
  4. Klicken Sie im Abschnitt „Anmeldedaten“ auf .
  5. Geben Sie das Ablaufdatum an, fügen Sie die API-Produkte hinzu und legen Sie deren Status fest.
  6. Optional: Widerrufen Sie einen der anderen API-Schlüssel nach Bedarf.
  7. Klicken Sie auf Speichern.

Anwendung genehmigen oder widerrufen

Eine App genehmigen oder widerrufen, wie unten beschrieben Wenn Sie eine Anwendung widerrufen, können genehmigte API-Schlüssel nicht mehr in API-Aufrufen für Apigee verwendet werden. Wenn Sie eine Anwendung neu genehmigen, können Sie alle genehmigten und gültigen API-Schlüssel für API-Aufrufe verwenden.

Wenn die App in anderen Organisationen registriert ist, müssen Sie diese in jeder dieser Organisationen widerrufen. Es kann einige Minuten dauern, bis die Änderungen von allen Message Processors erkannt werden.

So genehmigen oder widerrufen Sie eine App:

  1. Seite „Apps“ aufrufen.
  2. Klicken Sie in die Zeile der App, die Sie aufrufen und bearbeiten möchten.
  3. Klicken Sie auf Bearbeiten.
  4. Wählen Sie im Feld App-Status die Option Genehmigen oder Widerrufen aus, um die App zu genehmigen oder zu widerrufen.
  5. Klicken Sie auf Speichern.

Apps löschen

Wenn Sie eine App löschen, werden alle mit den Apps verknüpften Clientschlüssel ungültig. Wenn Sie einen ungültigen Schlüssel für eine Anfrage verwenden, schlägt die Anfrage fehl.

Wenn Sie eine Entwickler-App in Zukunft wieder aktivieren möchten, können Sie auch statt Löschen eine App widerrufen.

So löschen Sie eine App:

  1. Seite „Apps“ aufrufen.
  2. Positionieren Sie den Cursor in der Zeile der App, die Sie löschen möchten.
  3. Klicken Sie in der Spalte „Aktionen“ auf .

Apps registrieren und API-Schlüssel mithilfe der API verwalten

Zum Registrieren und Verwalten von Anwendungen mit der Apigee API verwenden Sie die folgenden APIs:

Siehe auch Vorhandene Consumer-Keys und Secrets importieren.