API REST + servidor MCP
API de Relatório SEO para
Desenvolvedores e Agentes IA
Crie relatórios via REST, faça polling até a conclusão e leia o mesmo relatório salvo que sua equipe vê no site. A mesma chave de API do seu plano pago conecta qualquer agente compatível com MCP.
Modelo de acesso
O acesso à API é vinculado à conta e protegido por chave. Escolha um plano, crie uma chave de API na sua conta, e todo novo site que você executar através da API usará os créditos do seu plano, exatamente como faria no site. Os créditos são redefinidos no primeiro dia de cada mês (UTC) e nunca são acumulados.
Sessões do site, chamadas API e sessões de agente lidas do mesmo estado de relatório salvo.
Crie um relatório, faça polling para status, então leia os resultados completos do mesmo objeto.
Endpoints disponíveis
/api/v1/reports/previewCrie uma pré-visualização de pontuação para integrações de parceiros em um plano pago.
/api/v1/reportsCrie um novo relatório ou reutilize um que já exista. Adicione "forceRerun": true para escanear o site novamente.
/api/v1/reports/:idObtenha o status mais recente do relatório e seções.
/api/v1/reports/:id/resultLeia os resultados completos do relatório.
/api/v1/reports/:id/download?format=jsonExporte o payload do relatório como JSON para integrações programáticas.
Quickstart: um relatório SEO a partir do curl
Três solicitações cobrem todo o fluxo, usando uma chave de API do seu plano pago. A primeira cria o relatório, a segunda faz polling até que seu status não esteja mais em fila ou em execução, e a terceira exporta-o. Um novo site usa um crédito; executar um site para o qual você já tem um relatório novamente não usa um crédito.
export SEOREPORT_API_KEY="sr__live_your_api_key"
# Send the key as a header file so it never sits in curl's argv, where ps shows
# it to every local user. printf is a shell builtin, so it spawns no process.
auth() { printf 'Authorization: Bearer %s\n' "$SEOREPORT_API_KEY"; }
# 1. Create a report and keep its job ID
JOB_ID=$(curl -s -X POST https://seoreport.dev/api/v1/reports \
-H @<(auth) \
-H "Content-Type: application/json" \
-d '{"url": "example.com"}' | jq -r '.report.jobId')
# 2. Poll until the report is no longer queued or running
while :; do
STATUS=$(curl -s "https://seoreport.dev/api/v1/reports/$JOB_ID" \
-H @<(auth) | jq -r '.report.status')
case "$STATUS" in queued|running) sleep 3 ;; *) break ;; esac
done
echo "status: $STATUS"
# 3. Export the finished report (format=pdf, md and txt also work)
curl -s "https://seoreport.dev/api/v1/reports/$JOB_ID/download?format=json" \
-H @<(auth) -o report.jsonAPI de monitoramento SEO
Um domínio registrado para monitoramento é reauditado a cada semana. Quando algo muda, o endereço de alerta recebe um e‑mail: um novo achado crítico ou de alta severidade, um achado crítico resolvido, ou uma mudança para uma faixa de pontuação diferente. Uma semana sem mudança não envia nada.
/api/v1/monitorsInicia o monitoramento semanal de um domínio; “enabled”: false pausa-o.
/api/v1/monitorsLista os domínios que esta conta monitora.
/api/v1/monitors?url=Interrompe o monitoramento de um domínio e exclui seus resultados armazenados.
# Uses the auth() helper from the quickstart above.
# Re-audit a domain every week and email [email protected] when it changes
curl -X PUT https://seoreport.dev/api/v1/monitors \
-H @<(auth) \
-H "Content-Type: application/json" \
-d '{"url": "example.com", "alertEmail": "[email protected]"}'
# List monitored domains
curl https://seoreport.dev/api/v1/monitors \
-H @<(auth)
# Stop monitoring (pass the host the list returns)
curl -X DELETE "https://seoreport.dev/api/v1/monitors?url=example.com" \
-H @<(auth)Monitoramento está incluído com planos pagos e não consome créditos de relatório.
Cliente Oficial TypeScript
Um cliente tipado para a API REST. Autentique com a chave de API do seu plano, então crie, faça polling e exporte relatórios do TypeScript.
Linha de Comando
Execute relatórios do seu terminal com sua chave de API. Uma instalação global.
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": "3f6c2a1e-8d4b-4c7a-9e21-5b0d7f4a6c18",
"status": "completed",
"targetUrl": "https://example.com"
},
"pollAfterMs": 0
}Pronto para construir?
Escolha um plano, crie uma chave API e comece a integrar relatórios SEO em seu produto.