APIs & Integrationen Übersicht

Dieser Abschnitt behandelt drei Aufgaben.

APIs dokumentieren bedeutet, OpenAPI-Spezifikationen in Endpunkt-Seiten zu rendern, die Leser direkt im Browser ausprobieren können. Die Jamdesk Search API macht Ihre Docs zu einer Datenquelle, die Chatbots, Support-Tools und KI-Agenten abfragen können. Integrationen verbinden Ihre Docs-Seite mit anderen Tools: Build-Benachrichtigungen in Slack, Analytics und E-Mail-Erfassung.

APIs dokumentieren

API Playground

Leser testen Endpunkte direkt in Ihren Docs, mit Live-Codebeispielen

OpenAPI-Beispiel

Eine Live-Endpunkt-Seite aus OpenAPI und wie Jamdesk sie rendert

Request- & Response-Beispiele

APIs mit den Komponenten RequestExample und ResponseExample dokumentieren

Jamdesk Search API

Beantworten Sie Fragen in Chatbots, Slack-Bots und KI-Agenten mit aktuellen Inhalten aus Ihren Docs.

Docs Search API

Durchsuchen Sie Ihre Docs per Programm

Such-Endpunkt

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

Integrationen

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

GitHub & Benachrichtigungen

GitHub-Integration

Die GitHub App für Repo-Zugriff und die Kontoverknüpfung für Build-Warnungen

Slack-Integration

Build-Benachrichtigungen im Kanal Ihres Teams

E-Mail-Anmeldungen

Anmeldungen sammeln mit Resend, Mailchimp, Kit, Loops, beehiiv, Brevo oder SendGrid

Seite einbetten

Ein „Was ist neu?“-Button in Ihrer eigenen App, der Ihr Changelog öffnet

Support- & Chat-Anbieter

Live-Chat-Widgets von Intercom und Front Chat

Analytics & Einwilligung

Jamdesk verfügt über integrierte Analytics, die keine Konfiguration benötigen. Nutzen Sie diese Seiten, um eigene Tools hinzuzufügen.

Google Analytics

GA4 mit einer Messungs-ID hinzufügen

Google Tag Manager

Einen GTM-Container auf jeder Seite laden

Plausible Analytics

Eine datenschutzfreundliche, schlanke Alternative zu Google Analytics

Analytics- & Session-Replay-Anbieter

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

Cookie-Einwilligung

Analytics hinter einem Consent-Banner von Osano oder Termly steuern

Richten Sie diese ein, ohne docs.json von Hand zu bearbeiten. Dashboard → Integrations schreibt den Block und löst einen Rebuild aus (GitHub-verbundene Projekte).