API e integraciones: resumen

Esta sección cubre tres tareas distintas, así que ayuda saber cuál te trae aquí.

Documentar tu API significa convertir las especificaciones de OpenAPI en páginas de endpoint que los lectores pueden probar en el navegador. La API de búsqueda de Jamdesk va en la dirección opuesta: tu documentación se convierte en una fuente de datos que los chatbots, las herramientas de soporte y los agentes de IA pueden consultar. Y las integraciones conectan tu sitio de documentación con las herramientas que lo rodean, desde notificaciones de build en Slack hasta analítica y captura de correos.

Documentar las API

API Playground

Los lectores prueban los endpoints directamente desde tu documentación, con ejemplos de código en vivo

Ejemplo de OpenAPI

Una página de endpoint generada en vivo a partir de OpenAPI, y cómo la renderiza Jamdesk

Ejemplos de solicitud y respuesta

Documenta las API con los componentes RequestExample y ResponseExample

API de búsqueda de Jamdesk

Impulsa chatbots, bots de Slack y agentes de IA con respuestas actualizadas desde tu propia documentación.

API de búsqueda de documentación

Busca tu documentación de forma programática

Endpoint de búsqueda

Referencia completa de POST /_api/search

Integraciones

Conecta la API de búsqueda con Intercom, Zendesk, Slack y bots personalizados

GitHub y notificaciones

Integración con GitHub

La app de GitHub para acceder al repositorio, y la vinculación de cuenta para las alertas de build

Integración con Slack

Notificaciones de build en el canal de tu equipo

Registros por correo

Recopila registros con Resend, Mailchimp, Kit, Loops, beehiiv, Brevo o SendGrid

Insertar una página

Un botón «What's new?» en tu propia app que abre tu changelog

Proveedores de soporte y chat

Widgets de chat en vivo de Intercom y Front Chat

Analítica y consentimiento

Jamdesk tiene analítica integrada que no necesita configuración. Estas páginas son para cuando también quieres añadir tus propias herramientas.

Google Analytics

Añade GA4 con un ID de medición

Google Tag Manager

Carga un contenedor de GTM en cada página

Plausible Analytics

Una alternativa ligera y centrada en la privacidad a Google Analytics

Proveedores de analítica y replay de sesiones

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

Consentimiento de cookies

Bloquea la analítica detrás de un banner de consentimiento de Osano o Termly

Todo lo anterior se puede configurar sin tocar docs.json manualmente: Dashboard → Integrations escribe el bloque por ti y activa un rebuild (proyectos conectados a GitHub).