APIs e integrações

Esta seção aborda três tarefas diferentes, então é útil saber qual delas você está procurando.

Documentar sua API significa renderizar especificações OpenAPI em páginas de endpoints que os leitores podem testar no navegador. A API de pesquisa do Jamdesk faz o caminho inverso: sua documentação se torna uma fonte de dados que chatbots, ferramentas de suporte e agentes de IA podem consultar. E as integrações conectam seu site de documentação às ferramentas ao redor dele, desde notificações de build no Slack até analytics e captura de e-mails.

Documentação de APIs

Playground da API

Os leitores testam endpoints diretamente na documentação, com exemplos de código ao vivo

Exemplo de OpenAPI

Uma página de endpoint gerada ao vivo com OpenAPI e como o Jamdesk a renderiza

Exemplos de requisição e resposta

Documente APIs com os componentes RequestExample e ResponseExample

API de pesquisa do Jamdesk

Ofereça respostas atualizadas da sua própria documentação a chatbots, bots do Slack e agentes de IA.

API de pesquisa de docs

Pesquise sua documentação por programação

Endpoint de pesquisa

Referência completa para POST /_api/search

Integrações

Conecte a API de pesquisa ao Intercom, Zendesk, Slack e bots personalizados

GitHub e notificações

Integração com GitHub

O GitHub App para acesso ao repositório e o vínculo da conta para alertas de build

Integração com Slack

Notificações de build no canal da sua equipe

Inscrições por e-mail

Colete inscrições com Resend, Mailchimp, Kit, Loops, beehiiv, Brevo ou SendGrid

Incorporar uma página

Um botão "What's new?" no seu próprio app que abre o changelog

Provedores de suporte e chat

Widgets de chat ao vivo do Intercom e do Front Chat

Analytics e consentimento

O Jamdesk oferece analytics integrados que não exigem configuração. Estas páginas são para quando você também quiser usar suas próprias ferramentas.

Google Analytics

Adicione o GA4 com um ID de medição

Google Tag Manager

Carregue um contêiner do GTM em todas as páginas

Plausible Analytics

Uma alternativa leve ao Google Analytics, com foco na privacidade

Provedores de analytics e reprodução de sessões

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

Consentimento de cookies

Coloque o analytics atrás de um banner de consentimento do Osano ou Termly

Tudo acima pode ser configurado sem editar docs.json manualmente: Dashboard → Integrations grava o bloco para você e aciona um novo build (projetos conectados ao GitHub).