Panoramica API e integrazioni

Questa sezione copre tre attività.

Documentare la tua API significa trasformare le specifiche OpenAPI in pagine degli endpoint che i lettori possono provare direttamente nel browser. La Jamdesk Search API trasforma la tua documentazione in una fonte di dati che chatbot, strumenti di supporto e agenti AI possono interrogare. Le integrazioni collegano il tuo sito di documentazione ad altri strumenti: notifiche di build su Slack, analisi e raccolta di iscrizioni via email.

Documentare le API

API Playground

I lettori testano gli endpoint direttamente dalla documentazione, con esempi di codice in tempo reale

OpenAPI Example

Una pagina di endpoint live generata da OpenAPI e il modo in cui Jamdesk la visualizza

Request & Response Examples

Documenta le API con i componenti RequestExample e ResponseExample

Jamdesk Search API

Rispondi a domande in chatbot, bot Slack e agenti AI con contenuti aggiornati dalla tua documentazione.

Docs Search API

Cerca nella tua documentazione via codice

Search Endpoint

Riferimento completo per POST /_api/search

Integrations

Collega la Search API a Intercom, Zendesk, Slack e bot personalizzati

GitHub e notifiche

GitHub Integration

La GitHub App per l'accesso al repository e il collegamento dell'account per gli avvisi di build

Slack Integration

Notifiche di build nel canale del tuo team

Email Signups

Raccogli iscrizioni con Resend, Mailchimp, Kit, Loops, beehiiv, Brevo o SendGrid

Embed a Page

Un pulsante "What's new?" nella tua app che apre il tuo changelog

Support & Chat Providers

Widget di chat dal vivo di Intercom e Front Chat

Analisi e consenso

Jamdesk include analisi integrate che non richiedono alcuna configurazione. Usa queste pagine per aggiungere i tuoi strumenti.

Google Analytics

Aggiungi GA4 con un ID di misurazione

Google Tag Manager

Carica un contenitore GTM su ogni pagina

Plausible Analytics

Un'alternativa leggera e orientata alla privacy a Google Analytics

Analytics & Session Replay Providers

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

Cookie Consent

Subordina le analisi a un banner di consenso di Osano o Termly

Configurale senza modificare manualmente docs.json. Dashboard → Integrations scrive il blocco e avvia una ricostruzione (progetti collegati a GitHub).