API do Visual Crawler

Execute extrações, leia os resultados, exporte arquivos e receba avisos no seu sistema, com uma chave de API ou dentro de um assistente de IA.

Começar

Crie uma chave em Configurações → API e MCP. Ela aparece uma única vez.

É assim que um sistema confere o preço de um concorrente todo dia, sem ninguém abrir o app.

Autenticação

Envie a chave no cabeçalho Authorization de toda chamada.

Cada chave vale só para o Visual Crawler e tem um de dois níveis de acesso. Somente leitura vê modelos, extrações e resultados. Acesso completo também executa extrações, exporta, cria com IA e gerencia webhooks. Uma chamada fora do acesso da chave recebe 403.

A chave aparece uma única vez, quando é criada. Guarde-a como uma senha e nunca a coloque em código que roda no navegador. Revogada, ela para de funcionar em até 1 minuto.

Limites

Sua conta tem um limite de requisições por minuto, que depende do seu plano e vale para todas as suas chaves deste produto juntas. O seu aparece em Configurações → API e MCP.

As respostas trazem os cabeçalhos RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset. Se passar do limite, a resposta é 429 com Retry-After: espere esse número de segundos e tente de novo.

Execuções e configurações com IA contam na cota do seu plano, como no app. O cabeçalho Visualcrawler-Cost diz quanto cada chamada gastou.

Listas vêm em páginas: limit (20 por padrão, no máximo 100) e cursor, com o nextCursor da página anterior.

Webhooks

Cadastre um endereço no painel da extração, em Webhooks, ou pela API. Cada aviso é um POST com JSON para esse endereço, no padrão Standard Webhooks.

Confira a assinatura antes de confiar no corpo. Use o corpo exatamente como chegou, sem reformatar o JSON, e o segredo mostrado quando o webhook foi salvo. O cabeçalho pode trazer mais de uma assinatura: aceite a entrega se qualquer uma bater. A mesma entrega pode chegar mais de uma vez: guarde o webhook-id das que já tratou e ignore as repetidas.

Responda com 2xx em até 10 segundos. Com qualquer outra resposta, a entrega é repetida em intervalos crescentes, por cerca de 16 horas. Um 410 desativa o endereço na hora, e 20 falhas seguidas também; ele volta pelo botão Reativar no painel da extração.

MCP

O Visual Crawler funciona dentro de assistentes de IA que falam MCP, como Claude Code e Cursor, e em ferramentas de automação como o n8n. O assistente usa a mesma chave de API e só faz o que o acesso dela permite.

Erros

Os erros vêm em application/problem+json, com os campos type, title, status, code e detail. Decida pelo code: ele não muda. O detail explica o caso e pode mudar.

openapi.json