API WebsiteCoach
Use a API WebsiteCoach para obter relatórios em cache e ações priorizadas para dashboards internos, portais de clientes e automações.
Ludwig Makhyan · Fundador, WebsiteCoach
Ir para a seção
Para que serve a API WebsiteCoach
A API WebsiteCoach dá a usuários registrados acesso programático aos mesmos dados de relatório que eles veem no app. Ela é indicada para dashboards internos, portais de clientes, fluxos de relatórios e ferramentas de automação que precisam de dados de saúde do site em JSON.
A documentação pública evita expor tokens privados, detalhes internos, rotas somente de admin ou configurações sensíveis de rastreamento. Os usuários geram e gerenciam seus próprios tokens API na área de perfil autenticada.
Relatório JSON em cache
Busque o relatório salvo mais recente de um domínio, incluindo pontuações, métricas, departamentos e evidências.
Endpoint de ações
Puxe apenas a lista priorizada de correções, incluindo prioridade, departamento, descrição, métrica, meta e confiança.
Prompts de correção com IA
Busque prompts prontos para copiar em ferramentas de IA, com evidências da auditoria, URLs, links de aprendizado e instruções manuais para correções no provedor.
Acesso com histórico
As visualizações de relatórios pela API são associadas ao usuário autenticado, para que os mesmos domínios apareçam no histórico da conta e do admin.
Controles de tokens
Usuários podem criar tokens separados para ferramentas diferentes e revogar um token sem expor senhas ou sessões.
Endpoints públicos da API
Relatório completo em cache
Use quando seu app precisar do relatório salvo completo de um domínio.
GET https://websitecoach.com/api/reports?url=example.com&token=YOUR_TOKEN&lang=enSomente ações
Use para criação de tickets, dashboards executivos ou integrações que precisam apenas da lista priorizada de correções.
GET https://websitecoach.com/api/actionitems?url=example.com&token=YOUR_TOKEN&lang=enPayloads de correção com IA
Use quando seu fluxo envia descobertas do WebsiteCoach para ChatGPT, Claude, Gemini, Cursor ou outro assistente de programação com IA.
GET https://websitecoach.com/api/payload?url=example.com&token=YOUR_TOKENA resposta retorna cada item de ação com departamento, prioridade, link de aprendizado, evidências da auditoria e um prompt estruturado. Os prompts orientam a IA a inspecionar primeiro o stack do usuário e, quando a correção pertence a DNS, CDN, e-mail, registrador, CMS ou outro console externo, a fornecer um roteiro manual detalhado em vez de inventar alterações de código.
Formato de token Bearer
Apps server-side podem enviar o token em um cabeçalho Authorization em vez da query string.
Authorization: Bearer YOUR_TOKENSegurança de tokens e dados
Mantenha tokens no servidor
- Não coloque tokens API em JavaScript público, apps móveis, capturas de tela ou documentos compartilhados.
- Crie tokens separados por app para que uma integração possa ser revogada sem quebrar as outras.
- Use apenas HTTPS e rotacione tokens quando um colega, fornecedor ou sistema não precisar mais de acesso.
- A API retorna apenas dados de relatório disponíveis ao proprietário autenticado do token; ela não expõe senhas, sessões, segredos de cobrança, rotas admin ou cabeçalhos privados de rastreamento.
Acesso e limites
O acesso à API está disponível para usuários registrados. Cada usuário pode criar até 10 tokens API ativos no perfil.
As chamadas de API são projetadas para recuperação de relatórios em cache e fluxos de ações. Novas varreduras e atualizações por crédito podem mudar, então integrações públicas devem usar os endpoints documentados de relatórios em cache e ações.
Para criar ou revogar tokens, entre e abra API tokens.
Precisa de uma integração privada?
Para casos de parceiros ou empresas, fale com a WebsiteCoach antes de depender de comportamento não público. A documentação pública é o contrato estável.
Tópicos relacionados
Verifique sua pontuação website agora
Auditoria gratuita em 60 segundos – sem necessidade de conta.
Execute auditoria gratuita