OpenAPI

OpenAPI ist ein Spezifikation zur Beschreibung von REST APIs. Mit OpenAPI-Spezifikation 2.0 können Sie OpenAPI-Dokumente für Business Messages und Business Kommunikations-APIs zur Beschreibung ihrer Struktur

Dadurch haben Sie folgende Möglichkeiten:

• Clientbibliotheken in Ihrer bevorzugten Sprache erstellen
• Server-Stubs erstellen
• API-Verwaltungstools verwenden

Grundstruktur eines OpenAPI-Dokuments

Ein OpenAPI-Dokument beschreibt die Oberfläche einer REST API. Im Dokument wird definiert, den Namen und die Beschreibung der API, die einzelnen Endpunkte (Pfade) in der API und wie die Aufrufer authentifiziert werden.

Klicken Sie unten, um ein Beispiel für diese Grundstruktur anzuzeigen.

JSON

    {
      "swagger": "2.0",
      "host": "businessmessages.googleapis.com",
      "info": {
        "title": "Business Messages API",
        "description": "",
        "version": "v1"
      },
      "paths": {
        "/v1/conversations/{conversationsId}/messages": {
          "post": {
            "description": "Sends a message from an agent to a user.",
            "parameters": [
              {
                "description": "Part of `parent`. Required. The conversation that contains the message. Resolves to \"conversations/{conversationId}\".",
                "type": "string",
                "in": "path",
                "required": true,
                "name": "conversationsId"
              },
              {
                "description": "Optional. A flag to send the specified fallback text instead of other message content.",
                "name": "forceFallback",
                "type": "boolean",
                "in": "query"
              },
              {
                "name": "message",
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "in": "body",
                "description": "Required. The content of a message."
              }
            ],
            "tags": [
              "businessmessages"
            ],
            "operationId": "CreateMessage",
            "responses": {
              "default": {
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "description": "Successful operation"
              }
            }
          }
        }
      }
    }
    

Weitere Informationen zur Struktur eines OpenAPI-Dokuments finden Sie in der Swagger-Website:

Auf OpenAPI-Dokumente zugreifen

Für den Zugriff auf die OpenAPI-Dokumente benötigen Sie einen API-Schlüssel von einer Google Cloud Plattformprojekt (GCP) mit Business Messages und Business Communications APIs aktiviert.

In den folgenden Abschnitten erfahren Sie,

• GCP-Projekt erstellen
• Erstellen eines API-Schlüssels
• Business Messages API und Business Communications API aktivieren

Wenn diese Schritte abgeschlossen sind, können Sie auf die OpenAPI-Dokumente zugreifen.

GCP-Projekt erstellen

Wenn Sie bereits ein GCP-Projekt haben, können Sie damit einen API-Schlüssel erstellen.

So erstellen Sie ein neues GCP-Projekt:

1. Rufen Sie den Bereich Ressourcen verwalten auf. in der GCP Console.
2. Führen Sie oben auf der Seite in der Drop-down-Liste Organisation auswählen die folgenden Schritte aus: wählen Sie die Organisation aus, für die Sie das Projekt erstellen möchten. Wenn Sie die kostenlose Testversion nutzen, überspringen Sie diesen Schritt.
3. Klicke auf Projekt erstellen.
4. Geben Sie im Fenster Neues Projekt einen Projektnamen ein und wählen Sie Rechnungskonto an. Ein Projektname darf nur Buchstaben, Ziffern und einzelne Anführungszeichen, Bindestriche, Leerzeichen oder Ausrufezeichen. Der Wert muss zwischen 4 und 30 Zeichen lang sein.

5. Geben Sie unter Speicherort die übergeordnete Organisation oder den übergeordneten Ordner für das neue Projekt ein.

6. Klicken Sie auf Erstellen.

API-Schlüssel erstellen

1. Gehen Sie zur Seite „Anmeldedaten“ in der GCP Console.

2. Klicken Sie auf Anmeldedaten erstellen und wählen Sie die Option API-Schlüssel aus.

   Das Dialogfeld API-Schlüssel erstellt enthält den neu erstellten Schlüssel. Kopieren Sie Ihren Schlüssel und bewahren Sie ihn sicher auf. Weitere Informationen zu API-Schlüsseln finden Sie in der Dokumentation zum API-Schlüssel

Business Communications API und Business Messages API aktivieren

So aktivieren Sie diese APIs in Ihrem GCP-Projekt:

1. Gehen Sie zur Seite APIs und Dienste in der GCP Console.
2. Wählen Sie in der Drop-down-Liste Projekt auswählen das gewünschte Projekt, für das Sie die APIs aktivieren möchten.
3. Klicken Sie auf APIs und Dienste aktivieren.
4. Geben Sie in das Feld Nach APIs und Diensten suchen Business Messages ein.
5. Wählen Sie Business Messages API aus.
6. Klicken Sie auf Aktivieren.
7. Klicken Sie auf APIs und Dienste aktivieren.
8. Geben Sie in das Feld Search for APIs and Services (Nach APIs und Diensten suchen) Business Communications ein.
9. Wählen Sie Business Communications API aus.
10. Klicken Sie auf Aktivieren.

Ihr API-Schlüssel verfügt jetzt über Berechtigungen zum Zugriff auf die OpenAPI-Dokumente für die Business Messages API und Business Communications API

Auf OpenAPI-Dokumente zugreifen

Führen Sie den folgenden Befehl aus, um auf das OpenAPI-Dokument für die Business Messages API zuzugreifen:

curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Führen Sie den folgenden Befehl aus, um auf das OpenAPI-Dokument für die Business Communications API zuzugreifen:

curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Ersetzen Sie API_KEY durch Ihren API-Schlüssel.