REST Danmark API-dokumentation

Drop-in kompatibilitet for offentlige Datafordeler REST- og GEOREST-tjenester, der udfases. Kunder skal kunne lave samme kald som før og få samme response-shape tilbage. Det eneste, der ændres, er base URL og API key.

Skift endpoint, behold kontrakten

Erstat services.datafordeler.dk med api.restdanmark.dk. Paths, query-parametre, JSON/XML-format og legacy wrappers bevares pr. registeradapter. En eksisterende Datafordeler-klient kan beholde sin username/password-struktur og sætte REST Danmark-nøglen som password. Eksisterende casing samt dobbelte eller afsluttende skråstreger i stien accepteres på samme måde som hos Datafordeleren.

Katalog

Offentlige legacy REST-metoder på tværs af de aktive registre.

Autentificering

§01.01

Alle kald kræver en REST Danmark API key. Nøglen kan sendes ix-api-keysom bearer-token, i query-parameteren apiKeyeller i legacy-parameteren password. API keys hashes i databasen og vises kun én gang ved oprettelse. En eksisterende Datafordeler-adgangskode accepteres ikke som REST Danmark-nøgle.

Adgang styres per register

Et abonnement kan give adgang til et enkelt register, flere registre eller alle aktive offentlige registre. Samme API key bruges til alle kald; gatewayen tjekker tenantens katalogadgang for hvert legacy path, før cache, adapter eller Datafordeler upstream bliver brugt.

cURL · request

curl -H "x-api-key: rd_live_..." \
  "https://api.restdanmark.dk/BBR/BBRPublic/1/rest/bygning?Format=JSON&kommunekode=0101"

Eksisterende username/password-klientSamme request-struktur

- https://services.datafordeler.dk/BBR/BBRPublic/1/REST/bygning?Format=JSON&username=jeres-bruger&password=jeres-datafordeler-password
+ https://api.restdanmark.dk/BBR/BBRPublic/1/REST/bygning?Format=JSON&username=jeres-bruger&password=rd_live_...

Behold parameter-navne, path og øvrige query-parametre. REST Danmark-nøglen erstatter værdien ipassword; username ignoreres og videresendes aldrig.

Registerkatalog

§02.01

Tabellen viser de offentlige registerfamilier, REST Danmark aktivt understøtter på den offentlige platform. “I drift” betyder, at JSON og XML er golden-testet for de captured query-shapes.

Kode	Register	Status	Coverage	Services og metoder
BBR	Bygnings- og Boligregistret Klimadatastyrelsen /docs/bbr	I drift	32/32 live parity targets	BBRPublic: bbrsag, bygning, ejendomsrelation, enhed, grund, tekniskanlaeg
DAR	Danmarks Adresseregister Klimadatastyrelsen /docs/dar	I drift	5/5 JSON, 5/5 XML	DAR_BFE_Public: adresseTilEnhedBfe, husnummerTilBygningBfe, husnummerTilTekniskAnlægBfe · DAR: adresseTilHusnummer
DAGI	Danmarks Administrative Geografiske Inddeling Klimadatastyrelsen /docs/dagi	I drift	8/8 live-cases · land, vand, JSON og XML	DAGI: DAGI
DHM	Danmarks Højdemodel Klimadatastyrelsen /docs/dhm	I drift	3/3 JSON, 3/3 XML · live 16/16	DHMKoter: HentKoter
EBR	Ejendomsbeliggenhedsregistret Klimadatastyrelsen /docs/ebr	I drift	3/3 endpoints · 7 JSON/XML cases · live 14/14	Ejendomsbeliggenhed: BFEnrAdresse, Ejendomsbeliggenhed, EjendomsbeliggenhedSimpel
MAT2	Matriklen2 Klimadatastyrelsen /docs/mat2	I drift	83 live-cases gennem GraphQL og historisk WFS	Matrikel: SamletFastEjendom, BygningPaaFremmedGrund, Ejerlejlighed, BestemtFastEjendom, MatrikelKommune · Matrikel: SamletFastEjendom, BygningPaaFremmedGrund, Ejerlejlighed, BestemtFastEjendom, MatrikelKommune, MatrikulaerSag
STEDNAVN	Danske Stednavne Klimadatastyrelsen /docs/stednavn	I drift	12/12 live-cases · JSON, XML, geop og CRS	Stednavne: HentDKStednavne
KORTBLAD	Kortbladsinddeling Klimadatastyrelsen /docs/kortblad	Adapter-backed	1/1 JSON, 1/1 XML	Kortbladsinddeling: HentKortbladsinddelingFraPunkt

Endpoint-eksempler

§02.02

BBRGET

/BBR/BBRPublic/1/rest/bygning?Format=JSON&count=True&status=6&kommunekode=0101

DARGET

/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?Format=XML&adresseId=<adresseId>

DAGIGET

/DAGIM/DAGI/1/rest/DAGI?Format=JSON&x=722125.86&y=6178892.29

DHMGET

/DHMTerraen/DHMKoter/1.0.0/georest/HentKoter?format=xml&geop=POINT(720000.0 6200000.0)

EBRGET

/EBR/Ejendomsbeliggenhed/1/rest/Ejendomsbeliggenhed?Format=JSON&BFEnr=6022778

MAT2GET

/Matriklen2/Matrikel/2.0.0/rest/MatrikulaerSag?Format=XML&SagsId=9022778

Fejl & statuskoder

§03.01

Kode	Navn	Betydning
401	missing_api_key	Ingen API key i header, apiKey-query eller legacy password-parameter.
403	invalid_api_key	Nøglen findes ikke eller er revoked.
403	catalog_not_enabled	API key er valid, men tenantens abonnement giver ikke adgang til registeret.
404	legacy_service_not_supported	Path eller metode findes ikke i REST Danmark-kataloget.
406	format_not_supported	Format er ikke understøttet for den konkrete registeradapter.
429	rate_limit_exceeded	Tenantens rate limit eller månedlige quota er opbrugt.
502	datafordeler_upstream	Datafordeler upstream svarede uventet; gatewayen retryer efter politik.
503	circuit_open	Circuit breaker er åben for at beskytte kunder og upstream.

Attribution & licens

§03.02

Alle aktive registeradapters returnererx-restdanmark-attributionmed kilde, Datafordeleren, relevant myndighed og licensvilkår. BBR-vilkår er CC BY 4.0; data må hentes, deles og tilpasses med passende kreditering.

Data source: Bygnings- og Boligregistret (BBR) | Distribution: Datafordeleren | Authority: Klimadatastyrelsen | License: CC BY 4.0

Næste skridt

Find jeres register, behold jeres Datafordeler-kald, og skift base URL.

Start med BBR