Panoramica API e integrazioni

Questa sezione tratta tre attività diverse, quindi è utile capire per quale motivo sei qui.

Documentare le tue API significa trasformare le specifiche OpenAPI in pagine degli endpoint che i lettori possono provare nel browser. La Jamdesk Search API funziona nella direzione opposta: la tua documentazione diventa una fonte di dati che chatbot, strumenti di supporto e agenti AI possono interrogare. Le integrazioni, invece, collegano il tuo sito di documentazione agli strumenti che lo supportano, dalle notifiche di build in Slack agli strumenti di analisi e alla raccolta delle email.

Documentare le API

API Playground

I lettori testano gli endpoint direttamente dalla documentazione, con esempi di codice eseguibili

Esempio OpenAPI

Una pagina di endpoint generata da OpenAPI e una spiegazione di come Jamdesk la visualizza

Esempi di richiesta e risposta

Documenta le API con i componenti RequestExample e ResponseExample

Jamdesk Search API

Offri a chatbot, bot Slack e agenti AI risposte aggiornate dalla tua documentazione.

API di ricerca della documentazione

Cerca nella documentazione via API

Endpoint di ricerca

Riferimento completo per POST /_api/search

Integrazioni

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

GitHub e notifiche

Integrazione GitHub

L'app GitHub per accedere al repository e collegare l'account agli avvisi di build

Integrazione Slack

Notifiche di build nel canale del tuo team

Iscrizioni email

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

Incorpora una pagina

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

Provider di supporto e chat

Widget di chat dal vivo di Intercom e Front Chat

Analisi e consenso

Jamdesk offre strumenti di analisi integrati che non richiedono configurazione. Queste pagine servono quando vuoi aggiungere anche i tuoi strumenti.

Google Analytics

Aggiungi GA4 con un ID di misurazione

Google Tag Manager

Carica un container GTM su ogni pagina

Plausible Analytics

Un'alternativa leggera a Google Analytics, attenta alla privacy

Provider di analisi e replay delle sessioni

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

Consenso per i cookie

Attiva l'analisi solo dopo il consenso tramite un banner Osano o Termly

Tutto quanto sopra può essere configurato senza modificare manualmente docs.json: Dashboard → Integrations scrive il blocco per te e avvia una nuova build (per i progetti collegati a GitHub).