Guía de Integración para Desarrolladores

Documentación y Referencia de la API REST

Integra el microservicio de OB-WebScraper en tus aplicaciones, plataformas e-commerce, ERPs o asistentes de IA. La API está diseñada para separar de forma eficiente la entrega de datos estructurados (JSON) de la previsualización y clonación web (HTML).

Pega este Markdown directamente en ChatGPT, Claude, DeepSeek o Cursor para contexto.
Extracción JSON

Precios, catálogo de productos, variantes y redes sociales normalizados.

Clonación HTML

Documento web listo para renderizar directamente en un <iframe>.

OB-Files CDN

Descarga e ingesta automática de imágenes a un CDN de alta disponibilidad.

Consumo como Servicio para Otras Apps (API REST)

Interactúa con la API para automatizar el scraping, extraer catálogos JSON u obtener previsualizaciones web en HTML.

JSON Data
HTML Preview
POST/api/v1/scrape
JSON

Inicia el scraping completo de la URL, procesa e ingesta imágenes a OB-Files CDN, persiste en BD y retorna inmediatamente los datos estructurados.

curl -X POST https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/scrape \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://tienda-ejemplo.com"
  }'
GET/api/v1/preview
HTML / JSON

Retorna la página web clonada/generada. Por defecto devuelve el documento HTML directo (para <iframe> o navegadores). Con ?format=json entrega el HTML encapsulado en JSON.

# 1. Obtener documento HTML directo (para <iframe src="..."> o render web):
curl -X GET "https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/preview?jobId=cmt7q8oxz0005lhacpxos43vt"

# 2. Obtener string HTML con lista de subpáginas en JSON:
curl -X GET "https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/preview?jobId=cmt7q8oxz0005lhacpxos43vt&format=json"
GET/api/v1/scrapes/[id]
JSON

Obtiene todo el payload JSON estructurado y el estado de un scraping ejecutado anteriormente consultando por su ID de trabajo o ID de website.

curl -X GET https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/scrapes/cmt7q8oxz0005lhacpxos43vt
GET/api/v1/scrapes
JSON

Retorna el listado completo e histórico de todos los sitios scrapeados y guardados en la base de datos PostgreSQL.

curl -X GET https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/scrapes

Ejemplo de Integración en TypeScript / JavaScript

Cómo disparar el scraping y consumir tanto los datos como la vista previa

// 1. Iniciar scraping y obtener datos JSON
async function scrapeAndPreview(targetUrl: string) {
  const response = await fetch("https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/scrape", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ url: targetUrl })
  });

  const result = await response.json();
  if (!result.success) {
    throw new Error(result.error || "Error al realizar el scraping");
  }

  console.log("Job ID generado:", result.jobId);
  console.log("Catálogo de productos:", result.data.products);
  console.log("Datos de empresa:", result.data.company);

  // 2. Si necesitas embeber el clon visual en tu aplicación:
  const iframePreviewUrl = `https://n8n-ob-webclon.ddt6vc.easypanel.host/api/v1/preview?jobId=${result.jobId}`;
  console.log("URL para <iframe src={iframePreviewUrl}>:", iframePreviewUrl);

  return result;
}

Códigos de Respuesta HTTP

CódigoEstadoDescripción
200 OKOperación ExitosaScraping completado con éxito o datos / HTML recuperados de la BD.
400 Bad RequestPetición InválidaFalta el parámetro 'url' en el body o no se proporcionó 'jobId' / 'pageId'.
404 Not FoundNo EncontradoEl trabajo o página especificada no existe en la base de datos.
500 Server ErrorError InternoError no controlado durante la descarga, extracción o persistencia en BD.