OpenAPI ist eine Spezifikation zur Beschreibung von REST APIs. Mit der OpenAPI-Spezifikation 2.0 können Sie OpenAPI-Dokumente für die Business Messages und Business Communications APIs erstellen, um ihre Struktur zu beschreiben.
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 werden unter anderem der Name und die Beschreibung der API, die einzelnen Endpunkte (Pfade) in der API und die Authentifizierung der Aufrufer definiert.
Klicken Sie unten, um ein Beispiel für diese Grundstruktur zu sehen.
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 auf der Swagger-Website.
Auf OpenAPI-Dokumente zugreifen
Für den Zugriff auf die OpenAPI-Dokumente benötigen Sie einen API-Schlüssel aus einem Google Cloud Platform (GCP)-Projekt mit aktivierten Business Messages und Business Communications APIs.
In den folgenden Abschnitten finden Sie
- ein GCP-Projekt erstellen
- Erstellen eines API-Schlüssels
- die Business Messages API und die Business Communications API aktivieren
Nach Abschluss dieser Schritte 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:
- Rufen Sie in der GCP Console die Seite Ressourcen verwalten auf.
- Wählen Sie oben auf der Seite in der Drop-down-Liste Organisation auswählen die Organisation aus, für die Sie das Projekt erstellen möchten. Überspringen Sie diesen Schritt, wenn Sie eine kostenlose Testversion nutzen.
- Klicke auf Projekt erstellen.
- Geben Sie im Fenster Neues Projekt einen Projektnamen ein und wählen Sie gegebenenfalls ein Rechnungskonto aus. Ein Projektname darf nur Buchstaben, Ziffern, einfache Anführungszeichen, Bindestriche, Leerzeichen oder Ausrufezeichen enthalten und muss zwischen 4 und 30 Zeichen lang sein.
Geben Sie unter Speicherort die übergeordnete Organisation oder den übergeordneten Ordner für das neue Projekt ein.
Klicken Sie auf Erstellen.
API-Schlüssel erstellen
Rufen Sie in der GCP Console die Seite Anmeldedaten auf.
Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel.
Das Dialogfeld API-Schlüssel erstellt enthält den neu erstellten Schlüssel. Kopieren Sie den Schlüssel und bewahren Sie ihn auf. Weitere Informationen zu API-Schlüsseln finden Sie in der Dokumentation zu API-Schlüsseln.
Business Communications API und Business Messages API aktivieren
So aktivieren Sie diese APIs in Ihrem GCP-Projekt:
- Rufen Sie in der GCP Console die Seite APIs und Dienste auf.
- Wählen Sie in der Drop-down-Liste Projekt auswählen das Projekt aus, für das Sie die APIs aktivieren möchten.
- Klicken Sie auf APIs und Dienste aktivieren.
- Geben Sie in das Feld Nach APIs und Diensten suchen den Text Business Messages ein.
- Wählen Sie Business Messages API aus.
- Klicken Sie auf Aktivieren.
- Klicken Sie auf APIs und Dienste aktivieren.
- Geben Sie in das Feld Nach APIs und Diensten suchen den Text Business Communications ein.
- Wählen Sie Business Communications API aus.
- Klicken Sie auf Aktivieren.
Ihr API-Schlüssel hat jetzt Berechtigungen für den Zugriff auf die OpenAPI-Dokumente für die Business Messages API und die Business Communications API.
Auf OpenAPI-Dokumente zugreifen
Führen Sie diesen 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 diesen 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.