📮 Postcode Helper

Validatie, formatting en verrijking van postcodes inclusief adres lookup.

← Terug naar Core Library

📖 Introductie

De Postcode Helper bevat utility functies voor het valideren, formatteren en verrijken van postcodes. Daarnaast ondersteunt deze helper Nederlandse adresopzoeking via Custom API’s.

👉 Deze helper combineert client-side logic met server-side validatie en data enrichment.
⚠️ Deze helper is afhankelijk van Custom API’s binnen Dataverse en werkt niet volledig standalone.

📦 Functionaliteit

✅ Validatie

  • isValid(postcode, country) → controleert geldigheid (async)

🧾 Formatting

  • format(postcode, country) → formatteert postcode (async)

🏠 Adres lookup (NL)

  • getDutchAddress(postcode, housenumber, housenumberAddition)

→ Haalt straat- en plaatsgegevens op voor Nederlandse adressen

⚙️ Werking

De Postcode Helper combineert server-side validatie met address enrichment.

👉 De helper gebruikt:
  • Custom API voor validatie en formatting
  • Specifieke API voor Nederlandse adres lookup

1. Validatie & formatting

  • Gebruikt Dataverse Custom API
  • Ondersteunt meerdere landen

2. Nederlandse adres lookup

  • Combineert postcode + huisnummer
  • Retourneert gestructureerde adresdata

🔌 Custom API’s

brenke_postalcode

Operaties

Operation Beschrijving
ISVALID Controleert postcode
FORMAT Formatteert postcode

Parameters

Naam Omschrijving
brenke_postalcode_country Landcode (NL, BE, DE, etc.)
brenke_postalcode_code Postcode
brenke_postalcode_operation Type operatie

brenke_dutchaddress

Parameters

Naam Omschrijving
brenke_dutchaddress_postalcode Postcode (zonder spatie)
brenke_dutchaddress_housenumber Huisnummer + toevoeging

Response

Field Omschrijving
street Straatnaam
city Plaats
municipality Gemeente
province Provincie

⚠️ Belangrijke aandachtspunten

  • Async gebruik → altijd await
  • format() → retourneert null bij invalid input
  • Alleen Nederlandse lookup voor NL postcodes
  • Automatische cleanup (uppercase + spaties verwijderen)
  • Huisnummer + toevoeging worden gecombineerd (bijv. 21A)
⚠️ Werkt alleen correct wanneer Custom API’s actief zijn binnen de omgeving.

💡 Voorbeelden

Postcode validatie

const valid = await core.Postcode.isValid("1234AB", "NL");
// true / false / null

Formatteren

const formatted = await core.Postcode.format("1234 ab", "NL");
// "1234 AB"

Adres ophalen

const address = await core.Postcode.getDutchAddress("1231VR", "21");
// { street: "...", city: "..." }

📊 Samenvatting

✅ Postcode validatie
✅ Formatting per land
✅ Adres verrijking (NL)
✅ Integratie via Custom API