Jamdesk Documentation logo

APIs & Integrationen – Übersicht

Dokumentieren Sie Ihre API mit OpenAPI und Playground, durchsuchen Sie Ihre Dokumentation per API und verbinden Sie GitHub, Slack, Analytics und E-Mail-Tools.

Dieser Abschnitt behandelt drei verschiedene Aufgaben. Daher ist es hilfreich zu wissen, wonach Sie suchen.

Ihre API dokumentieren bedeutet, OpenAPI-Spezifikationen in Endpoint-Seiten umzuwandeln, die Leser im Browser ausprobieren können. Die Jamdesk Search API funktioniert in die andere Richtung: Ihre Dokumentation wird zu einer Datenquelle, die Chatbots, Support-Tools und KI-Agenten abfragen können. Und Integrationen verbinden Ihre Dokumentationswebsite mit den Tools in ihrer Umgebung – von Build-Benachrichtigungen in Slack bis hin zu Analytics und der Erfassung von E-Mail-Adressen.

APIs dokumentieren

API Playground

Leser testen Endpoints direkt in Ihrer Dokumentation mit Live-Codebeispielen

OpenAPI-Beispiel

Eine live von OpenAPI generierte Endpoint-Seite und deren Darstellung durch Jamdesk

Anfrage- und Antwortbeispiele

Dokumentieren Sie APIs mit den Komponenten RequestExample und ResponseExample

Jamdesk Search API

Versorgen Sie Chatbots, Slack-Bots und KI-Agenten mit aktuellen Antworten aus Ihrer eigenen Dokumentation.

Docs Search API

Durchsuchen Sie Ihre Dokumentation programmgesteuert

Search Endpoint

Vollständige Referenz für POST /_api/search

Integrationen

Verbinden Sie die Search API mit Intercom, Zendesk, Slack und benutzerdefinierten Bots

GitHub & Benachrichtigungen

GitHub-Integration

Die GitHub-App für den Repository-Zugriff und die Kontoverknüpfung für Build-Benachrichtigungen

Slack-Integration

Build-Benachrichtigungen im Kanal Ihres Teams

E-Mail-Anmeldungen

Erfassen Sie Anmeldungen mit Resend, Mailchimp, Kit, Loops, beehiiv, Brevo oder SendGrid

Seite einbetten

Eine Schaltfläche „What's new?“ in Ihrer eigenen App, die Ihr Änderungsprotokoll öffnet

Support- und Chat-Anbieter

Live-Chat-Widgets von Intercom und Front Chat

Analytics & Einwilligung

Jamdesk bietet integrierte Analytics, die keine Konfiguration erfordern. Diese Seiten sind für den Fall gedacht, dass Sie zusätzlich eigene Tools einsetzen möchten.

Google Analytics

Fügen Sie GA4 mit einer Mess-ID hinzu

Google Tag Manager

Laden Sie auf jeder Seite einen GTM-Container

Plausible Analytics

Eine datenschutzorientierte, leichtgewichtige Alternative zu Google Analytics

Analytics- und Session-Replay-Anbieter

PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch und Koala

Cookie-Einwilligung

Schalten Sie Analytics hinter einem Einwilligungsbanner von Osano oder Termly frei

All of the above can be configured without touching docs.json by hand: Dashboard → Integrations writes the block for you and triggers a rebuild (GitHub-connected projects).