Jamdesk Documentation logo

Visão geral de APIs e integrações

Documente sua API com OpenAPI e o playground interativo, pesquise sua documentação programaticamente e conecte GitHub, Slack, ferramentas de análise e e-mail.

Esta seção cobre três tarefas.

Documentar sua API significa renderizar especificações OpenAPI em páginas de endpoints que os leitores podem testar no navegador. A API de busca Jamdesk transforma sua documentação em uma fonte de dados que chatbots, ferramentas de suporte e agentes de IA podem consultar. Integrações conectam seu site de documentação a outras ferramentas: notificações de build no Slack, análise e captura de e-mails.

Documentação de APIs

API Playground

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

OpenAPI Example

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

Request & Response Examples

Documente APIs com os componentes RequestExample e ResponseExample

API de pesquisa do Jamdesk

Responda perguntas em chatbots, bots do Slack e agentes de IA com conteúdo atualizado da sua documentação.

Docs Search API

Pesquise sua documentação programaticamente

Search Endpoint

Referência completa de POST /_api/search

Integrations

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

GitHub e notificações

GitHub Integration

O GitHub App para acesso aos repositórios e a vinculação de conta para alertas de build

Slack Integration

Notificações de build no canal da sua equipe

Email Signups

Capture cadastros com Resend, Mailchimp, Kit, Loops, beehiiv, Brevo ou SendGrid

Embed a Page

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

Support & Chat Providers

Widgets de chat ao vivo do Intercom e do Front Chat

Analytics e consentimento

A Jamdesk tem análise integrada que não exige configuração. Use estas páginas para adicionar suas próprias ferramentas por cima.

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 e focada em privacidade ao Google Analytics

Analytics & Session Replay Providers

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

Cookie Consent

Condicione a análise a um banner de consentimento do Osano ou do Termly

Configure isso sem editar docs.json manualmente. Dashboard → Integrations grava o bloco e dispara um rebuild (projetos conectados ao GitHub).