Documentación de la API

Descripción General

StructuredValidator proporciona una API RESTful para extraer datos estructurados JSON-LD de páginas web. La API es de uso gratuito con limitación de velocidad para garantizar un uso justo.

Autenticación

No se requiere autenticación. La API es de acceso público con limitación de velocidad basada en dirección IP.

Endpoints

{
  "url": "https://example.com/page"
}

{
  "success": true,
  "url": "https://example.com/page",
  "schemasFound": 2,
  "schemas": [
    {
      "format": "json-ld",
      "type": "Article",
      "content": {
        "@context": "https://schema.org",
        "@type": "Article",
        "headline": "Example Article",
        "author": {
          "@type": "Person",
          "name": "John Doe"
        }
      },
      "raw": "..."
    },
    {
      "format": "microdata",
      "type": "Product",
      "content": {
        "@context": "https://schema.org",
        "@type": "Product",
        "name": "Example Product",
        "price": "29.99"
      },
      "raw": "..."
    }
  ]
}

{
  "statusCode": 400,
  "message": "URL parameter is required"
}

// Rate limit exceeded
{
  "statusCode": 429,
  "message": "Rate limit exceeded. Try again after..."
}

curl -X POST https://structuredvalidator.com/api/extract-schema \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/page"}'

Limitación de Velocidad

Para garantizar un uso justo, la API implementa:

• Límite: 50 solicitudes por hora por dirección IP
• Ventana: Ventana rodante de 1 hora
• Encabezados: La información del límite de velocidad se incluye en cada respuesta

Si excede el límite de velocidad, recibirá una respuesta 429 Too Many Requests con información sobre cuándo puede reintentar.

Mejores Prácticas

• Verifique el encabezado X-RateLimit-Remaining para monitorear su uso
• Implemente retroceso exponencial cuando reciba errores de límite de velocidad
• Almacene en caché las respuestas cuando sea posible para reducir las llamadas a la API
• Valide las URLs del lado del cliente antes de hacer llamadas a la API
• Maneje los errores de red y tiempos de espera con gracia

Códigos de Estado HTTP