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

Conta gratuita + chave API

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.

Um objeto de relatório

Sessões do site, chamadas API e sessões de agente lidas do mesmo estado de relatório salvo.

Fluxo direto

Crie um relatório, verifique o status e, em seguida, leia a pré-visualização ou resultados completos do mesmo objeto.

Endpoints disponíveis

POST/api/v1/reports/preview

Criar uma pré-visualização de pontuação para fluxos de parceiro e lançamento de produto.

POST/api/v1/reports

Crie um novo relatório ou reutilize um que já exista.

GET/api/v1/reports/:id

Obtenha o status mais recente do relatório e seções.

GET/api/v1/reports/:id/result

Leia os resultados completos assim que o relatório for desbloqueado.

GET/api/v1/reports/:id/download?format=json

Exporte 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.

Bash
npm install -g @seoreport/client

Servidor 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.

Configuração do cliente MCPJSON
{
  "mcpServers": {
    "seoreport": {
      "url": "https://seoreport.dev/mcp",
      "headers": {
        "Authorization": "Bearer sr__live_your_api_key"
      }
    }
  }
}
create_report

Inicie um relatório para uma URL e receba um ID de trabalho.

get_report_status

Verifique o trabalho até o relatório ficar pronto.

get_report

Leia o relatório concluído com a pontuação e os achados.

list_reports

Liste os relatórios da conta.

get_report_download

Obtenha uma URL de download em JSON, Markdown, texto ou PDF.

get_usage

Consulte 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.

Exemplo de RespostaJSON
{
  "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.