Validate API | eConnect

Mit der Validate API können Sie ein XML-Dokument validieren, ohne es im PSB zu speichern oder zu versenden. Das macht sie ideal als Pre-Flight-Check, bevor Sie ein Dokument tatsächlich versenden, oder zum Testen von Dokumenten während der Entwicklung Ihrer Integration.

Endpoint

POST /api/v1/generic/validate

Senden Sie das XML-Dokument als Body mit Content-Type application/xml. Der PSB analysiert das Dokument und gibt ein Validierungsergebnis zurück.

Intelligente Dokumenterkennung

Die Validate API erkennt automatisch, welches Dokumentformat Sie eingereicht haben, basierend auf dem XML-Inhalt. Sie müssen nicht angeben, ob es sich um eine NLCIUS-Rechnung, eine Peppol BIS Billing V3-Rechnung, eine UBL-Bestellung oder ein anderes Format handelt. Die API erkennt dies selbst und wendet die richtigen Validierungsregeln an.

Dies funktioniert für alle Dokumenttypen, die der PSB unterstützt: Rechnungen, Gutschriften, Bestellungen, Order Responses und mehr.

Validierungsergebnis

Die Antwort enthält einen isValid-Boolean und eine Liste von 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."
    }
  ]
}

Jede Assertion hat ein flag mit einem der folgenden Werte:

Flag

Bedeutung

success

Validierungsregel erfolgreich bestanden

warning

Hinweis, aber kein blockierender Fehler

error

Validierungsfehler, Dokument wird nicht akzeptiert

Die Validierung prüft sowohl das XSD-Schema (Struktur) als auch Geschäftsregeln (inhaltliche Regeln wie Pflichtfelder und Wertebereiche).

Doppelte Validierung

Der PSB validiert standardmäßig gegen die aktuellste Version der Validierungsartefakte. Wenn das Dokument gegen die neueste Version nicht valide ist, aber gegen die vorherige Version, die noch im Netzwerk akzeptiert wird, werden beide Ergebnisse zurückgegeben. So wissen Sie, ob Ihr Dokument jetzt noch versendet werden kann und ob Sie für zukünftige Kompatibilität upgraden müssen.

Benutzerdefinierte Validierungsregeln (optionId)

Für spezifische Validierungsanforderungen können Sie eine optionId als Queryparameter übergeben:

POST /api/v1/generic/validate?optionId=Ihre-option-id

Dies aktiviert einen vordefinierten Satz von Validierungsregeln, zum Beispiel kundenspezifische Anforderungen oder Branchenstandards. Welche Optionen verfügbar sind, können Sie abfragen über:

GET /api/v1/generic/validate/options

Spracheinstellungen

Standardmäßig sind die Assertions auf Englisch. Möchten Sie die Validierungsmeldungen auf Niederländisch erhalten? Senden Sie den X-EConnect-Language-Header mit:

X-EConnect-Language: nl

Unterstützte Sprachen sind unter anderem nl (Niederländisch) und en (Englisch).

Wann verwenden?

Die Validate API ist besonders nützlich in den folgenden Szenarien:

Während der Entwicklung: Testen Sie Ihre Dokumente, bevor Sie den Send-Endpoint aufrufen
Pre-Flight-Check: Validieren Sie Dokumente in Ihrer eigenen Anwendung, bevor sie an den PSB gesendet werden, sodass Sie Ihren Benutzern direktes Feedback geben können
Batch-Validierung: Prüfen Sie eine große Menge von Dokumenten auf Fehler, bevor Sie sie versenden

Technisch: Die Validate API speichert das Dokument nicht im PSB. Das Dokument wird validiert und das Ergebnis sofort zurückgegeben. Es werden keine Webhooks ausgelöst und keine Kosten berechnet.

Die vollständige API-Spezifikation finden Sie unter psb.econnect.eu mit allen Parametern und Beispiel-Payloads.

Dokument validieren

Verwandt