API REST + servidor MCP
A API de relatórios SEO para
desenvolvedores e agentes de IA
Crie relatórios via REST, verifique o status e leia o mesmo objeto de relatório salvo que sua equipe vê no site. A mesma chave API conecta qualquer agente compatível com MCP.
Modelo de acesso
O acesso API está vinculado à conta. Crie uma conta gratuita, emita uma chave API e comece com pré-visualizações de pontuação. Nenhum cartão é necessário para o caminho de avaliação.
Sessões do site, chamadas API e sessões de agente lidas do mesmo estado de relatório salvo.
Crie um relatório, verifique o status e, em seguida, leia a pré-visualização ou resultados completos do mesmo objeto.
Endpoints disponíveis
/api/v1/reports/previewCriar uma pré-visualização de pontuação para fluxos de parceiro e lançamento de produto.
/api/v1/reportsCrie um novo relatório ou reutilize um que já exista.
/api/v1/reports/:idObtenha o status mais recente do relatório e seções.
/api/v1/reports/:id/resultLeia os resultados completos assim que o relatório for desbloqueado.
/api/v1/reports/:id/download?format=jsonExporte o payload do relatório como JSON para integrações programáticas.
Cliente Oficial TypeScript
Autenticação zero-config, pronto para camada gratuita, pronto para plataforma de lançamento.
Linha de Comando
Execute relatórios a partir do seu terminal. Uma instalação global, visualizações instantâneas.
npm install -g @seoreport/clientServidor MCP — a mesma API, a mesma chave
Aponte qualquer cliente compatível com MCP para https://seoreport.dev/mcp e autentique-se com a mesma chave API Bearer que usa no REST. As ferramentas de relatório e de conta são anunciadas na conexão, então um agente pode executar uma auditoria e ler os achados sem código intermediário.
{
"mcpServers": {
"seoreport": {
"url": "https://seoreport.dev/mcp",
"headers": {
"Authorization": "Bearer sr__live_your_api_key"
}
}
}
}create_reportInicie um relatório para uma URL e receba um ID de trabalho.
get_report_statusVerifique o trabalho até o relatório ficar pronto.
get_reportLeia o relatório concluído com a pontuação e os achados.
list_reportsListe os relatórios da conta.
get_report_downloadObtenha uma URL de download em JSON, Markdown, texto ou PDF.
get_usageConsulte os créditos restantes e o período de faturamento atual.
Pagamento, cancelamento e exclusão de conta devolvem uma URL de confirmação no navegador em vez de agir diretamente. Um agente pode iniciá-los; só uma pessoa pode concluí-los.
{
"success": true,
"report": {
"jobId": "383c5318-5e81-45a8-9df8-579d10442f72",
"stage": "snapshot_ready",
"status": "completed",
"targetUrl": "https://rbeckner.com",
"isSnapshotReady": true,
"preview": {
"sectionKeys": ["hero_summary", "top_findings"]
},
"paidUnlock": {
"unlockEligible": true,
"unlocked": false
}
},
"pollAfterMs": 0
}Pronto para construir?
Obtenha sua chave API gratuita e comece a integrar relatórios SEO em seu produto.