/ docs
ProduktZnalostiVývojári
Platforma Control
Validate API: validácia dokumentov bez odoslania

Validácia XML dokumentov bez uloženia: inteligentná detekcia, viacjazyčné assertions a vlastné pravidlá.

Pomocou Validate API môžete zvalidovať XML dokument bez jeho uloženia alebo odoslania cez PSB. To ho robí ideálnym ako pre-flight kontrolu pred skutočným odoslaním dokumentu, alebo na testovanie dokumentov počas vývoja Vašej integrácie.

Endpoint
POST /api/v1/generic/validate

Odošlite XML dokument ako telo s content-type application/xml. PSB dokument analyzuje a vráti výsledok validácie.

Inteligentná detekcia dokumentov

Validate API automaticky rozpozná, aký formát dokumentu ste dodali na základe XML obsahu. Nemusíte uvádzať, či ide o NLCIUS faktúru, Peppol BIS Billing V3 faktúru, UBL Order alebo iný formát. API to detekuje sama a aplikuje správne validačné pravidlá.

Toto funguje pre všetky typy dokumentov, ktoré PSB podporuje: faktúry, dobropisy, objednávky, order responses a ďalšie.

Výsledok validácie

Odpoveď obsahuje boolean isValid a zoznam 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 nasledujúcich hodnôt:

FlagVýznamsuccessValidačné pravidlo úspešne splnenéwarningUpozornenie, ale nie blokujúca chybaerrorValidačná chyba, dokument nebude akceptovaný

Validácia kontroluje tak XSD schému (štruktúru), ako aj business pravidlá (obsahové pravidlá ako povinné polia a rozsahy hodnôt).

Dvojitá validácia

PSB štandardne validuje voči najnovšej verzii validačných artefaktov. Ak dokument nie je platný voči najnovšej verzii, ale je platný voči predchádzajúcej verzii, ktorá je ešte akceptovaná v sieti, oba výsledky sa vrátia. Tak viete, či Váš dokument ešte môže byť odoslaný a či potrebujete upgrade pre budúcu kompatibilitu.

Vlastné validačné pravidlá (optionId)

Pre špecifické validačné potreby môžete pridať optionId ako query parameter:

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

Tým sa aktivuje vopred definovaná sada validačných pravidiel, napríklad zákaznícky špecifické požiadavky alebo odvetvové štandardy. Dostupné možnosti si vyžiadate cez:

GET /api/v1/generic/validate/options
Jazykové nastavenia

Štandardne sú assertions v angličtine. Chcete validačné správy v holandčine? Odošlite hlavičku X-EConnect-Language:

X-EConnect-Language: nl

Podporované jazyky zahŕňajú nl (holandčina) a en (angličtina).

Kedy použiť?

Validate API je obzvlášť užitočná v nasledujúcich scenároch:

  • Počas vývoja: testujte dokumenty pred volaním send endpointu
  • Pre-flight kontrola: validujte dokumenty vo Vašej aplikácii pred odoslaním do PSB, aby ste používateľom poskytli priamu spätnú väzbu
  • Dávková validácia: skontrolujte veľkú sadu dokumentov na chyby pred odoslaním

Technické: Validate API dokument neukladá v PSB. Dokument sa zvaliduje a výsledok sa priamo vráti. Nespúšťajú sa žiadne webhooky a neúčtujú sa žiadne poplatky.

Pozrite si kompletnú API špecifikáciu na psb.econnect.eu pre všetky parametre a vzorové payloady.

Zvalidujte dokument

Súvisiace
PreviousOrder Response
NextTransform API