Validate API: validar documentos sin envío

Validar documentos XML sin almacenamiento: smart detection, assertions multilingües y reglas personalizadas.

La Validate API le permite validar un documento XML sin almacenarlo ni enviarlo a través de la PSB. Esto la hace ideal como pre-flight check antes de enviar un documento, o para probar documentos durante el desarrollo de su integración.

Endpoint
POST /api/v1/generic/validate

Envíe el documento XML en el body con el content-type application/xml. La PSB analiza el documento y devuelve un resultado de validación.

Smart document detection

La Validate API detecta automáticamente el formato de su documento basándose en el contenido XML. No necesita indicar si se trata de una factura NLCIUS, una factura Peppol BIS Billing V3, un UBL Order u otro formato. La API lo detecta por sí misma y aplica las reglas de validación correspondientes.

Esto funciona para todos los tipos de documentos compatibles con la PSB: facturas, notas de crédito, pedidos, respuestas a pedidos y más.

Resultado de validación

La respuesta contiene un booleano isValid y una lista de assertions:

{
  "isValid": false,
  "assertions": [
    {
      "artifact": "schema",
      "flag": "error",
      "text": "Element 'cbc:InvoiceTypeCode' is missing."
    },
    {
      "artifact": "business-rules",
      "flag": "warning",
      "text": "BR-NL-10: TaxTotal should contain at least one TaxSubtotal."
    }
  ]
}

Cada assertion tiene un flag con uno de los siguientes valores:

FlagSignificadosuccessRegla de validación superada con éxitowarningPunto de atención, pero sin error bloqueanteerrorError de validación, el documento no será aceptado

La validación comprueba tanto el esquema XSD (estructura) como las business rules (reglas de negocio como campos obligatorios y rangos de valores).

Doble validación

La PSB valida por defecto contra la versión más reciente de los artefactos de validación. Si el documento no es válido contra la última versión, pero sí contra la versión anterior que aún se acepta en la red, se devuelven ambos resultados. De esta manera, usted sabe si su documento todavía se puede enviar y si necesita actualizar para garantizar la compatibilidad futura.

Reglas de validación personalizadas (optionId)

Para necesidades de validación específicas, puede incluir un optionId como parámetro de consulta:

POST /api/v1/generic/validate?optionId=jouw-optie-id

Esto activa un conjunto predefinido de reglas de validación, por ejemplo requisitos específicos de un cliente o estándares sectoriales. Para consultar las opciones disponibles, utilice:

GET /api/v1/generic/validate/options
Configuración de idioma

Por defecto, las assertions están en inglés. Si desea recibir los mensajes de validación en neerlandés, envíe el header X-EConnect-Language:

X-EConnect-Language: nl

Los idiomas compatibles incluyen nl (neerlandés) y en (inglés).

¿Cuándo utilizarla?

La Validate API es especialmente útil en los siguientes escenarios:

  • Durante el desarrollo: pruebe sus documentos antes de llamar al endpoint de envío
  • Pre-flight check: valide los documentos en su propia aplicación antes de enviarlos a la PSB, para proporcionar retroalimentación directa a sus usuarios
  • Validación por lotes: verifique un gran conjunto de documentos antes de enviarlos

Técnico: La Validate API no almacena el documento en la PSB. El documento se valida y el resultado se devuelve de inmediato. No se activan webhooks ni se generan costes.


Consulte la especificación API completa en psb.econnect.eu para todos los parámetros y ejemplos de payloads.

Validar un documento

Relacionado
Artículos relacionados