API de SEO

A API de SEO do Screpy é uma API REST para levar dados de projetos, rastreamentos, Rank Tracker, AI Visibility armazenada, páginas, monitoramento e oportunidades para seus próprios produtos, painéis e automações. Use respostas JSON estruturadas para criar fluxos de SEO com os dados que sua conta Screpy pode acessar.

Iniciar teste grátis Ver preços

TL;DR

Demasiado longo; não lido

Mostrar resumo

O que é a API de SEO do Screpy?

A API de SEO do Screpy é uma API REST para contas de membros pagantes que expõe projetos Screpy acessíveis, rastreamentos concluídos, Rank Tracker, dados armazenados e gerenciamento de prompts da AI Visibility, comparações, Core Web Vitals e disponibilidade por meio de solicitações JSON autenticadas. Ela foi criada para software personalizado, sistemas de relatórios e automações; use uma chave de API REST em vez de credenciais OAuth do MCP.

Acesso e contexto da conta

As chaves da API de SEO do Screpy são criadas em Configurações → Aplicativos conectados e enviadas como tokens Bearer em cada solicitação REST.
A API de SEO do Screpy está disponível para contas de membros pagantes e verifica elegibilidade, limites de recursos e acesso ao projeto em cada solicitação.
A API de SEO do Screpy lista projetos pertencentes à conta autenticada ou compartilhados com ela, começando por GET /projects.
A API de SEO do Screpy retorna uso da conta, limites do plano, cota restante e disponibilidade dos recursos antes de iniciar rastreamentos ou processar grandes resultados.

Projetos, rastreamentos e comparações

A API de SEO do Screpy lista, cria, atualiza e exclui projetos acessíveis para aplicações de SEO personalizadas e fluxos de clientes.
A API de SEO do Screpy usa um UID de projeto para solicitações específicas e retorna um UID de rastreamento da lista do projeto selecionado.
A API de SEO do Screpy retorna status do rastreamento, resumos de rastreamentos concluídos, indicadores de saúde, contagens de problemas e totais para fluxos técnicos de SEO.
A API de SEO do Screpy compara dois rastreamentos concluídos para que um painel ou automação possa investigar mudanças entre referências técnicas de SEO.

Registros de rastreamento e dados de monitoramento

A API de SEO do Screpy retorna páginas, links, imagens, resultados on-page e Quick Wins de um rastreamento concluído selecionado.
A API de SEO do Screpy mantém o escopo do projeto e do rastreamento unido e oferece paginação para grandes conjuntos de resultados.
A API de SEO do Screpy retorna Core Web Vitals e disponibilidade por endpoints de saúde separados, pois desempenho e disponibilidade são sinais diferentes.
A API de SEO do Screpy pode retornar data: null quando não há uma verificação de saúde correspondente. As integrações devem confirmar a configuração do monitoramento antes de interpretar isso como falha do site.

Conecte seu produto aos dados de SEO.

Crie uma chave de API REST, descubra os projetos acessíveis à sua conta e use identificadores estáveis de projeto no seu painel, automação ou aplicativo.

Saiba mais sobre acesso à api rest

Criar chaves de API REST em Configurações → Aplicativos conectados
Autenticar solicitações com um token Bearer
Descobrir projetos próprios e compartilhados antes de escolher um UID
Ler uso da conta e limites de recursos antes de fluxos dispendiosos

GET /v1/projects 200 OK

{
  "data": [
    {
      "uid": "prj_8f3a1",
      "name": "Example site",
      "domain": "example.com",
      "role": "owner"
    }
  ]
}

Execute fluxos de rastreamento da sua própria stack.

Conecte gerenciamento de projetos, status de rastreamentos, resumos concluídos e comparações aos sistemas que sua equipe já usa nas operações de SEO.

Saiba mais sobre projetos e rastreamentos

Criar e gerenciar projetos acessíveis do Screpy por endpoints REST
Usar UIDs de projeto e rastreamento para ler um site e rastreamento selecionados
Monitorar progresso, indicadores de saúde, problemas e totais
Comparar rastreamentos concluídos quando um lançamento, migração ou alteração de conteúdo precisar de investigação

GET /v1/projects/{project_uid}/crawls 200 OK

{
  "data": [
    {
      "uid": "crw_42c91",
      "status": "completed",
      "health": { "score": 91 },
      "issues": { "critical": 2, "warnings": 14 }
    }
  ]
}

Transforme registros de SEO em automações.

Use registros de rastreamentos concluídos, Quick Wins, verificações de desempenho e sinais de disponibilidade como entradas estruturadas para relatórios, notificações e fluxos internos de SEO.

Saiba mais sobre dados e saúde do rastreamento

Recuperar páginas, links, imagens e resultados on-page de um rastreamento concluído
Usar Quick Wins para oportunidades priorizadas do Search Console
Paginar grandes conjuntos de dados sem misturar registros de rastreamentos diferentes
Manter Core Web Vitals e disponibilidade junto dos dados que exigem acompanhamento

POST /v1/comparisons/crawls 200 OK

{
  "data": {
    "change": {
      "health_score": 4,
      "critical_issues": -3,
      "indexable_pages": 12
    }
  }
}

Endpoints da API de SEO para fluxos personalizados

Construa diretamente sobre os dados e fluxos do Screpy importantes para seu produto: acesso à conta, projetos, rastreamentos, Rank Tracker, AI Visibility armazenada, registros detalhados, comparações e saúde do site.

Chaves de API REST

Crie uma chave de API REST em Configurações → Aplicativos conectados e autentique cada solicitação com um token Bearer.

Uso da conta

Leia limites do plano, cotas de recursos e uso restante antes de uma integração iniciar rastreamentos ou processar muitos registros.

Gerenciamento de projetos

Liste, crie, atualize e exclua os projetos Screpy disponíveis para a chave de API REST no seu fluxo personalizado.

Fluxos de rastreamento

Leia a lista de rastreamentos de um projeto e use o UID retornado para conectar resultados selecionados ao seu aplicativo.

Resumos de rastreamento

Retorne status, indicadores de saúde, contagens de problemas, totais e progresso para relatórios e monitoramento técnico de SEO.

Comparações de rastreamentos

Compare dois rastreamentos concluídos quando seu produto precisar mostrar o que mudou entre referências técnicas de SEO.

Registros de páginas

Recupere registros de páginas e detalhes exatos para análises técnicas de SEO por URL em uma interface personalizada.

Registros de links e imagens

Recupere links, imagens e o contexto da página de origem em um rastreamento concluído selecionado.

Resultados on-page

Use o contexto da auditoria on-page e os registros de rastreamento para criar uma revisão técnica focada em URLs importantes.

Quick Wins

Leve oportunidades priorizadas do Search Console para um painel ou automação interna com o contexto do projeto e do período do relatório.

API do Rank Tracker

Leia visibilidade, histórico de palavras-chave, resultados armazenados e segmentos; adicione ou exclua palavras-chave rastreadas e gerencie segmentos baseados em URL.

API da AI Visibility

Leia dados armazenados de resumo, menções, respostas, citações, prompts e fontes e adicione ou exclua logicamente prompts rastreados dentro do limite do plano.

Dados de Core Web Vitals

Recupere resultados disponíveis de Core Web Vitals pela API de saúde para fluxos de SEO focados em desempenho.

Dados de disponibilidade

Recupere status de disponibilidade e incidentes recentes para exibir esses sinais ao lado dos dados técnicos de SEO.

Perguntas sobre a API de SEO.

Saiba como a API REST do Screpy autentica solicitações, delimita projetos e rastreamentos e expõe dados para produtos e automações de SEO personalizados.

Como crio uma chave da API de SEO do Screpy?

Crie uma chave de API REST em Configurações → Aplicativos conectados e envie-a como token Bearer em cada solicitação. As credenciais OAuth do MCP não autenticam a API REST do Screpy.

Quem pode usar a API de SEO do Screpy?

A API REST do Screpy está disponível para contas de membros pagantes. Cada solicitação verifica a elegibilidade, os limites de recursos e o acesso ao projeto solicitado.

Como encontro um UID de projeto e um UID de rastreamento?

Comece com GET /projects para listar os projetos disponíveis para a chave. Use o UID do projeto selecionado com sua lista de rastreamentos, que retorna o UID para solicitações de dados específicas.

Quais dados a API de SEO do Screpy pode retornar?

Para um rastreamento concluído selecionado, a API REST pode retornar páginas, links, imagens, resultados on-page e Quick Wins. Mantenha o escopo do projeto e do rastreamento unido ao criar relatórios ou automações.

A API de SEO do Screpy pode comparar rastreamentos?

Sim. A API de comparações aceita duas referências de rastreamentos concluídos e retorna uma comparação estruturada para investigar mudanças entre as referências.

Posso gerenciar o Rank Tracker pela API?

Sim. A API oferece resumo do Rank Tracker, listagem e gerenciamento de palavras-chave, histórico e resultados armazenados e visualização ou gerenciamento de segmentos. Não oferece exportação CSV/XLSX, consulta SERP ao vivo nem nova análise manual.

Posso usar a AI Visibility pela API?

Sim. A API lê dados armazenados de resumo, menções, respostas, citações, prompts e fontes e pode adicionar ou excluir logicamente prompts rastreados. As exportações CSV e Excel continuam exclusivas do painel; sugestões e nova análise manual não estão disponíveis na API.

Posso obter Core Web Vitals e disponibilidade pela API?

Sim. Core Web Vitals e disponibilidade são expostos por endpoints de saúde separados porque são sinais diferentes. Uma resposta data: null pode indicar que ainda não há uma verificação correspondente disponível.

Qual é a diferença entre a API de SEO do Screpy e o SEO MCP?

A API de SEO do Screpy é uma API REST para produtos, painéis e automações personalizados, autenticada com uma chave REST. O Screpy SEO MCP expõe ferramentas estruturadas do Screpy a assistentes de IA compatíveis por OAuth e pelo Model Context Protocol.