Erste Schritte mit dem Cloud Endpoints-Portal

Auf dieser Seite wird beschrieben, wie Sie ein Portal für den Cloud Endpoints-Dienst erstellen. Außerdem erhalten Sie eine Einführung in die Benutzeroberfläche des Portals. Zu jeder Aufgabe werden die Rollen für Identity and Access Management (IAM) angegeben, die mindestens für die Durchführung der Aufgabe erforderlich sind. Weitere Informationen zu IAM-Berechtigungen finden Sie hier:

Vorbereitung

Folgende Voraussetzungen sollten erfüllt sein:

Portal erstellen

So erstellen Sie ein Portal:

  1. Rufen Sie in der Google Cloud Console die Seite Endpunkte > Entwicklerportal auf.

    Zum Cloud Endpoints-Portal

  2. Wählen Sie das Cloud-Projekt aus, in dem sich die API befindet.
  3. Klicken Sie auf Portal erstellen. Das Generieren des Portals dauert normalerweise zwischen 5 und 10 Minuten. Sobald das Portal erstellt wurde, wird eine URL angezeigt, über die Sie darauf zugreifen können.

Das Erstellen eines Portals hat folgende Auswirkungen:

  • Beim Erstellen des Portals wird ein Dienstkonto mit dem Namen service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com und der Rolle Endpoints-Portal-Dienst-Agent erstellt. YOUR_PROJECT_NUMBER ist die Projektnummer Ihres Cloud-Projekts. Sie können das Dienstkonto in der Google Cloud Console auf der Seite IAM unter IAM für Ihr Cloud-Projekt aufrufen.

  • Bei der Erstellung des Portals wird der Domainname endpointsportal.YOUR_PROJECT_ID.cloud.goog verwendet. YOUR_PROJECT_ID ist die ID Ihres Cloud-Projekts. Dafür werden ein SSL/TLS-Zertifikat und ein öffentlicher DNS-Datensatz mit Ihrer Projekt-ID erstellt. Sie können in den öffentlichen Zertifikatstransparenzlogs gesucht werden, obwohl Ihr Portal nicht öffentlich zugänglich ist.

Portal für eine API aufrufen

So rufen Sie das Portal für eine API auf:

  1. Klicken Sie auf der Seite Endpoints > Entwicklerportal im Abschnitt Portal-URL auf die URL.

  2. Folgen Sie bei der Anmeldung den Eingabeaufforderungen, um zum Portal zu gelangen. Wenn Sie mehrere Konten haben, wählen Sie das Konto aus, das sich im Cloud-Projekt mit der API befindet.

    Die Startseite des Portals wird angezeigt. Der Einfachheit halber sollten Sie diese URL mit einem Lesezeichen versehen. Auf der Startseite des Portals wird eine Liste mit Links zu allen APIs im Cloud-Projekt angezeigt.

  3. Klicken Sie auf die API, die Sie entdecken möchten. Die Startseite der API wird angezeigt.

Einführung in die Benutzeroberfläche des Portals

Am unteren Rand der Startseite der API werden die folgenden Symbole angezeigt. Dabei handelt es sich um nützliche Links für die Nutzer der API.

  • Die API-Referenz führt zur ersten Seite der SmartDocs API-Referenzdokumentation, die vom Endpoints-Portal auf Grundlage Ihres OpenAPI-Dokuments generiert wurde. Mit der Navigationsleiste auf der linken Seite können Sie sich die SmartDocs-Dokumentation für jede Methode und Ressource anzeigen lassen.

  • Erste Schritte  führt zum Beispielinhalt im Startleitfaden. Bevor Sie die Portal-URL an die Nutzer Ihrer API senden, passen Sie diese Dokumentation an, um Informationen bereitzustellen, die die Nutzer für die Verwendung der API in ihrem Code benötigen. Unter Eigene Dokumentation hinzufügen erfahren Sie, wie Sie den Inhalt der Anleitung Erste Schritte ändern können.

  • Schlüssel abrufen  führt zur Seite APIs & Dienste > Bibliothek, damit Nutzer Ihre API in ihren eigenen Google Cloud-Projekten aktivieren können.

    Wenn die API einen API-Schlüssel erfordert, können Nutzer nach Aktivierung der API die Seite APIs und Dienste > Anmeldedaten aufrufen, um einen API-Schlüssel zu erhalten, den sie in ihrem Code verwenden können. Bevor Sie die Portal-URL an die API-Nutzer senden, müssen Sie ihnen Zugriff auf die API gewähren. Weitere Informationen finden Sie unter Aktivierung der API steuern.

Darstellung des Portals anpassen

Sie haben die Möglichkeit, die Farbschemata und die Symbole für Ihr Portal so zu ändern, dass sie zur Website Ihres Unternehmens passen. Sie können Ihren Nutzern eine markenspezifische Umgebung bieten, indem Sie die Darstellung des Portals anpassen und für dieses eine benutzerdefinierte Domain einrichten.

So passen Sie die Darstellung des Portals an:

  1. Klicken Sie in der rechten oberen Ecke der Seite auf Einstellungen .

  2. Klicken Sie auf den Tab Gesamte Website. Sie können die Darstellung folgender Elemente ändern:

    • Logo
    • Primäre Farbe, die als Hintergrundfarbe der Startseite und der Titelleiste verwendet wird
    • Sekundäre Farbe, die als Farbe für Symbole und Links verwendet wird
    • Titel der Startseite
    • Beschreibung der Startseite

  3. Klicken Sie auf Speichern.

Portal löschen

So löschen Sie ein Portal:

  1. Rufen Sie in der Google Cloud Console die Seite Endpunkte > Entwicklerportal auf.

    Zum Cloud Endpoints-Portal

  2. Wählen Sie das Cloud-Projekt aus, in dem sich die API befindet.
  3. Klicken Sie auf Löschen .
  4. Klicken Sie im Bestätigungsdialogfeld auf Löschen.

Nächste Schritte

Erfahren Sie mehr über: