API et intégrations : aperçu

Cette section couvre trois tâches différentes, il est donc utile de savoir laquelle vous concerne.

Documenter votre API signifie transformer des spécifications OpenAPI en pages d'endpoint que les lecteurs peuvent tester dans le navigateur. L'API de recherche Jamdesk va dans l'autre sens : votre documentation devient une source de données que les chatbots, les outils de support et les agents IA peuvent interroger. Et les intégrations connectent votre site de documentation aux outils qui l'entourent, des notifications de build dans Slack à l'analytique et la capture d'e-mails.

Documenter les API

API Playground

Les lecteurs testent des endpoints directement depuis votre documentation, avec des exemples de code en direct

Exemple OpenAPI

Une page d'endpoint générée en direct à partir d'OpenAPI, et comment Jamdesk la génère

Exemples de requête et réponse

Documentez les API avec les composants RequestExample et ResponseExample

API de recherche Jamdesk

Alimentez des chatbots, des bots Slack et des agents IA avec des réponses à jour provenant de votre propre documentation.

API de recherche de la documentation

Recherchez votre documentation par programmation

Endpoint de recherche

Référence complète pour POST /_api/search

Intégrations

Connectez l'API de recherche à Intercom, Zendesk, Slack et des bots personnalisés

GitHub et notifications

Intégration GitHub

La GitHub App pour l'accès au dépôt, et la liaison de compte pour les alertes de build

Intégration Slack

Notifications de build dans le canal de votre équipe

Inscriptions par e-mail

Collectez des inscriptions avec Resend, Mailchimp, Kit, Loops, beehiiv, Brevo ou SendGrid

Intégrer une page

Un bouton « Quoi de neuf ? » dans votre propre application, qui ouvre votre changelog

Fournisseurs de support et de chat

Widgets de chat en direct Intercom et Front Chat

Analytique et consentement

Jamdesk dispose d'une analytique intégrée qui ne nécessite aucune configuration. Ces pages sont utiles si vous souhaitez également ajouter vos propres outils.

Google Analytics

Ajoutez GA4 avec un ID de mesure

Google Tag Manager

Chargez un conteneur GTM sur chaque page

Plausible Analytics

Une alternative légère et axée sur la confidentialité à Google Analytics

Fournisseurs d'analytique et de replay de session

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

Consentement aux cookies

Bloquez l'analytique derrière une bannière de consentement Osano ou Termly

Tout ce qui précède peut être configuré sans toucher à docs.json manuellement : Dashboard → Integrations écrit le bloc pour vous et déclenche un rebuild (projets connectés à GitHub).