/ docs
ProduktZnalostiVývojáři
Platforma Control
Validate API: validace dokumentů bez odeslání

Validace XML dokumentů bez uložení: inteligentní detekce, vícejazyčné assertions a vlastní pravidla.

Pomocí Validate API můžete zvalidovat XML dokument bez jeho uložení nebo odeslání přes PSB. To ho dělá ideálním jako pre-flight kontrolu před skutečným odesláním dokumentu, nebo pro testování dokumentů během vývoje Vaší integrace.

Endpoint
POST /api/v1/generic/validate

Odešlete XML dokument jako tělo s content-type application/xml. PSB dokument analyzuje a vrátí výsledek validace.

Inteligentní detekce dokumentů

Validate API automaticky rozpozná, jaký formát dokumentu jste dodali na základě XML obsahu. Nemusíte uvádět, zda jde o NLCIUS fakturu, Peppol BIS Billing V3 fakturu, UBL Order nebo jiný formát. API to detekuje sama a aplikuje správná validační pravidla.

Toto funguje pro všechny typy dokumentů, které PSB podporuje: faktury, dobropisy, objednávky, order responses a další.

Výsledek validace

Odpověď obsahuje boolean isValid a seznam 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."
    }
  ]
}

Každá assertion má flag s jednou z následujících hodnot:

FlagVýznamsuccessValidační pravidlo úspěšně splněnowarningUpozornění, ale ne blokující chybaerrorValidační chyba, dokument nebude akceptován

Validace kontroluje jak XSD schéma (strukturu), tak i business pravidla (obsahová pravidla jako povinná pole a rozsahy hodnot).

Dvojitá validace

PSB standardně validuje vůči nejnovější verzi validačních artefaktů. Pokud dokument není platný vůči nejnovější verzi, ale je platný vůči předchozí verzi, která je ještě akceptována v síti, oba výsledky se vrátí. Tak víte, zda Váš dokument ještě může být odeslán a zda potřebujete upgrade pro budoucí kompatibilitu.

Vlastní validační pravidla (optionId)

Pro specifické validační potřeby můžete přidat optionId jako query parametr:

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

Tím se aktivuje předem definovaná sada validačních pravidel, například zákaznicky specifické požadavky nebo odvětvové standardy. Dostupné možnosti si vyžádáte přes:

GET /api/v1/generic/validate/options
Jazykové nastavení

Standardně jsou assertions v angličtině. Chcete validační zprávy v nizozemštině? Odešlete hlavičku X-EConnect-Language:

X-EConnect-Language: nl

Podporované jazyky zahrnují nl (nizozemština) a en (angličtina).

Kdy použít?

Validate API je obzvlášť užitečná v následujících scénářích:

  • Během vývoje: testujte dokumenty před voláním send endpointu
  • Pre-flight kontrola: validujte dokumenty ve Vaší aplikaci před odesláním do PSB, abyste uživatelům poskytli přímou zpětnou vazbu
  • Dávková validace: zkontrolujte velkou sadu dokumentů na chyby před odesláním

Technické: Validate API dokument neukládá v PSB. Dokument se zvaliduje a výsledek se přímo vrátí. Nespouštějí se žádné webhooky a neúčtují se žádné poplatky.

Podívejte se na kompletní API specifikaci na psb.econnect.eu pro všechny parametry a vzorové payloady.

Zvalidujte dokument

Související
PreviousOrder Response
NextTransform API