Aperçu des API et intégrations

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

Documenter votre API consiste à transformer des spécifications OpenAPI en pages d'endpoint que les lecteurs peuvent tester directement dans le navigateur. L'API de recherche Jamdesk fonctionne 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 collecte d'emails.

Documenter les API

API Playground

Les lecteurs testent les 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 l'affiche

Exemples de requête et de réponse

Documentez vos API avec les composants RequestExample et ResponseExample

API de recherche Jamdesk

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

API de recherche des docs

Recherchez dans 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

L'application GitHub pour l'accès aux dépôts et la liaison de compte pour les alertes de build

Intégration Slack

Notifications de build dans le canal de votre équipe

Inscriptions par email

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

Intégrer une page

Un bouton « Nouveautés ? » dans votre propre application qui ouvre votre changelog

Analytique et consentement

Jamdesk propose une analytique intégrée qui ne nécessite aucune configuration. Ces pages sont utiles si vous souhaitez aussi ajouter vos propres outils en plus.

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

Consentement aux cookies

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