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 og send jeres nøgle i x-api-key. Paths, query-parametre, JSON/XML-format og legacy wrappers bevares pr. registeradapter.
Katalog
Aktive Datafordeler legacy endpoints i det offentlige katalog.
Autentificering
§01.01Alle kald kræver en REST Danmark API key. Nøglen sendes enten ix-api-keyeller som bearer-token. API keys hashes i databasen og vises kun én gang ved oprettelse.
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 -H "x-api-key: rd_live_..." \ "https://api.restdanmark.dk/BBR/BBRPublic/1/rest/bygning?Format=JSON&kommunekode=0101"
Registerkatalog
§02.01Tabellen 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 | 15/15 JSON, 15/15 XML | BBRPublic: bbrsag, bygning, ejendomsrelation, enhed, grund, tekniskanlaeg |
| DAR | Danmarks Adresseregister Klimadatastyrelsen /docs/dar | I drift | 4/4 JSON, 4/4 XML | DAR_BFE_Public: adresseTilEnhedBfe, husnummerTilBygningBfe, husnummerTilTekniskAnlægBfe · DAR: adresseTilHusnummer |
| DAGI | Danmarks Administrative Geografiske Inddeling Klimadatastyrelsen /docs/dagi | I drift | 1/1 JSON, 1/1 XML | DAGI: DAGI |
| DHM | Danmarks Højdemodel Klimadatastyrelsen /docs/dhm | I drift | 2/2 JSON, 2/2 XML | DHMKoter: HentKoter |
| EBR | Ejendomsbeliggenhedsregistret Klimadatastyrelsen /docs/ebr | I drift | 3/3 JSON, 3/3 XML | Ejendomsbeliggenhed: BFEnrAdresse, Ejendomsbeliggenhed, EjendomsbeliggenhedSimpel |
| MAT2 | Matriklen2 Klimadatastyrelsen /docs/mat2 | I drift | 18/18 JSON, 18/18 XML | Matrikel: SamletFastEjendom, BygningPaaFremmedGrund, Ejerlejlighed, BestemtFastEjendom, MatrikelKommune · Matrikel: SamletFastEjendom, BygningPaaFremmedGrund, Ejerlejlighed, BestemtFastEjendom, MatrikelKommune, MatrikulaerSag |
| STEDNAVN | Danske Stednavne Klimadatastyrelsen /docs/stednavn | I drift | 2/2 JSON, 2/2 XML | Stednavne: HentDKStednavne |
| KORTBLAD | Kortbladsinddeling Klimadatastyrelsen /docs/kortblad | Adapter-backed | 1/1 JSON, 1/1 XML | Kortbladsinddeling: HentKortbladsinddelingFraPunkt |
Endpoint-eksempler
§02.02/BBR/BBRPublic/1/rest/bygning?Format=JSON&count=True&status=6&kommunekode=0101
/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?Format=XML&adresseId=<adresseId>
/DAGIM/DAGI/1/rest/DAGI?Format=JSON&x=722125.86&y=6178892.29
/DHMTerraen/DHMKoter/1.0.0/georest/HentKoter?format=xml&geop=POINT(720000.0 6200000.0)
/EBR/Ejendomsbeliggenhed/1/rest/Ejendomsbeliggenhed?Format=JSON&BFEnr=6022778
/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 x-api-key eller Authorization-header. |
| 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.02Alle 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