Dokumentation

API'et følger DAWA's stier, parametre og svarformat. Kender du DAWA, kender du det her.

Autentificering

Nøglen sendes enten som query-parameter eller som header:

curl "http://localhost:3001/adresser?postnr=8000&per_side=1&token=DIN_NØGLE"

curl -H "Authorization: Bearer DIN_NØGLE" \
     "http://localhost:3001/adresser?postnr=8000&per_side=1"

Query-parameteren findes fordi browser-widgets ikke kan sætte headers, og fordi en eksisterende DAWA-integration så kan flytte med uden kodeændring. Bruger du den fra en browser, så husk at nøglen bliver synlig for brugeren — lav i så fald en nøgle kun til det formål, så den kan tilbagekaldes for sig.

Endpoints

Sti	Beskrivelse
`/adresser`	Søg og filtrér adresser
`/adresser/{id}`	Slå én adresse op
`/adgangsadresser`	Søg og filtrér adgangsadresser
`/adgangsadresser/{id}`	Slå én adgangsadresse op

Parametre

Parameter	Værdier
`struktur`	`nestet` (standard), `mini`
`srid`	`4326` (standard), `25832`
`side`, `per_side`	Paginering, højst 25.000 elementer i dybden
`kommunekode`, `postnr`, `vejkode`, `vejnavn`, `husnr`	Filtre
`sognekode`, `regionskode`, `retskredskode`, `politikredskode`	Administrative filtre
`medtagnedlagte`, `medtagugyldige`	Medtag ikke-gældende adresser

Som hos DAWA adskiller | alternativer (kommunekode=0101|0147) og * er et efterstillet jokertegn (vejnavn=Vester*).

Fejl

Fejlsvar har samme form som DAWA's, så eksisterende fejlhåndtering virker uændret:

{
  "type": "QueryParameterFormatError",
  "title": "One or more query parameters was ill-formed.",
  "details": [["side", "Der kan højst pagineres i de første 25000 elementer"]]
}

Kode	Betydning
`401`	Manglende eller ugyldig nøgle
`402`	Abonnementet er udløbet
`429`	For mange kald i sekundet

Forskelle fra DAWA

Disse felter findes i svaret med samme nøgler, men er null, fordi de kommer fra registre vi ikke henter i første version:

Felt	Årsag
`ejerlav`, `matrikelnr`, `esrejendomsnr`, `jordstykke`	Matriklen
`bebyggelser`	Danske Stednavne
`adgangspunkt.højde`	Findes ikke i adresseregisteret — alle punkter er todimensionelle
`brofast`	Udledes af DAWA, ikke et registerfelt

Endnu ikke implementeret: struktur=flad, formaterne geojson, csv og ndjson, geosøgning med cirkel og polygon, autocomplete, reverse geocoding, datavask, samt /vejstykker, /vejnavne, /postnumre og DAGI-endpointsene. fuzzy accepteres men ignoreres.

Datagrundlag

Adresser og vejnavne kommer fra Danmarks Adresseregister (DAR), administrative inddelinger fra DAGI — begge via Datafordeleren. Data hentes hver nat med et fuldt genindlæs ugentligt som kontrol.