Validare documenti XML senza salvataggio: rilevamento intelligente, assertion multilingue e regole personalizzate.
Con la Validate API può validare un documento XML senza salvarlo o inviarlo tramite la PSB. Questo la rende ideale come pre-flight check prima di inviare effettivamente un documento, o per testare documenti durante lo sviluppo della Sua integrazione.
POST /api/v1/generic/validate
Invii il documento XML come body con content-type application/xml. La PSB analizza il documento e restituisce un risultato di validazione.
La Validate API riconosce automaticamente quale formato di documento è stato fornito sulla base del contenuto XML. Non è necessario specificare se si tratta di una fattura NLCIUS, una fattura Peppol BIS Billing V3, un ordine UBL o un altro formato. L'API lo rileva autonomamente e applica le regole di validazione appropriate.
Questo funziona per tutti i tipi di documento supportati dalla PSB: fatture, note di credito, ordini, order response e altro.
La risposta contiene un boolean isValid e una lista di 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."
}
]
}
Ogni assertion ha un flag con uno dei seguenti valori:
successwarningerrorLa validazione verifica sia lo schema XSD (struttura) sia le regole di business (regole di contenuto come campi obbligatori e intervalli di valori).
La PSB valida per impostazione predefinita rispetto alla versione più recente degli artefatti di validazione. Se il documento non è valido rispetto alla versione più recente ma lo è rispetto alla versione precedente ancora accettata nella rete, vengono restituiti entrambi i risultati. In questo modo sa se il Suo documento può ancora essere inviato ora e se deve effettuare un aggiornamento per la compatibilità futura.
Per esigenze di validazione specifiche può aggiungere un optionId come parametro query:
POST /api/v1/generic/validate?optionId=jouw-optie-id
Questo attiva un set predefinito di regole di validazione, ad esempio requisiti specifici del cliente o standard di settore. Quali opzioni sono disponibili si possono consultare tramite:
GET /api/v1/generic/validate/options
Per impostazione predefinita le assertion sono in inglese. Desidera ricevere i messaggi di validazione in olandese? Invii l'header X-EConnect-Language:
X-EConnect-Language: nl
Le lingue supportate includono nl (olandese) e en (inglese).
La Validate API è particolarmente utile nei seguenti scenari:
Tecnico: la Validate API non salva il documento nella PSB. Il documento viene validato e il risultato viene restituito immediatamente. Non vengono attivati webhook e non vengono addebitati costi.
Consulti la specifica API completa su psb.econnect.eu per tutti i parametri e i payload di esempio.
Validi un documento