API-Spezifikation eines individuellen Plugins herunterladen
Individuelle Plugins werden für bestimmte Tenants eingerichtet und mit deiner Organisation abgestimmt. Dein Team weiß, ob ein solches Plugin für euren Workspace aktiviert wurde. Für nähere Informationen und individuelle Anpassungen erreichst du uns unter sales@tourfold.com.
Jedes aktivierte Plugin hat eine eigene OpenAPI-Spezifikation. Lade sie im jeweiligen Workspace herunter, damit sie zur API der dort bereitgestellten Anwendung passt.
- Melde dich in deinem Tourfold-Workspace an und öffne Einstellungen → Allgemein.
- Wähle Funktionen & Plugins zwischen Arbeitsbereich und Zurücksetzen.
- Suche das Plugin unter Plugins und wähle daneben OpenAPI-Spezifikation herunterladen.
Der Download ist eine JSON-Datei namens tourfold-plugin-<plugin-id>-openapi.json.
Du kannst sie in einen OpenAPI-Viewer oder Client-Generator importieren. Falls der Download
fehlschlägt, versuche es mit derselben Schaltfläche erneut.
Die authentifizierte Download-URL lautet GET /plugins/{plugin_id}/openapi auf dem API-Server
deiner Umgebung. Verwende die Kennung des Plugins, das für deinen Workspace eingerichtet wurde.
Inhalt der Datei
Das Dokument beschreibt die HTTP-Operationen des Plugins, Anfrage- und Antwortschemas, Authentifizierung, Fehlerantworten und Ereignisschemas für den gemeinsamen Ereignisstrom. Gemeinsam verwendete Schemas, auf die diese Operationen verweisen, sind enthalten. Operationen anderer Plugins und die allgemeine Tourfold-API sind nicht enthalten. Für die allgemeine API gibt es eine eigene OpenAPI-Referenz und einen YAML-Download.
Enthaltene Operationen externer Integrationen behalten ihre vereinbarten Kompatibilitätsregeln.
Die Spezifikation weist gegebenenfalls auf veraltete Routen und deren aktuelle Ersatzrouten hin.
Ein Plugin ohne HTTP-Operationen erhält ein gültiges OpenAPI-Dokument mit einem leeren paths-Objekt.
Die Liste zeigt nur aktivierte Plugins des Workspaces. Zum Herunterladen musst du angemeldet sein, und das Plugin muss für den Workspace aktiviert sein. Der Download erteilt keine zusätzlichen API-Berechtigungen: Für Anfragen gelten weiterhin die in der Datei beschriebenen Anforderungen.
Lade nach einer Bereitstellung mit Änderungen an der Plugin-API eine neue Kopie herunter.
info.version bezeichnet die Version des API-Vertrags, nicht die Build-Nummer der Anwendung.