Spring til indhold

Grundfast

Fejlkatalog

Alle HTTP-statusser, API’et kan svare med, opdelt i fejltyper, med hvad du skal gøre ved hver — maskinlæsbart og uden nøgle.

GET/v1/errors

Kataloget er den samme liste, som Fejl og statuskoder viser, og som API’et selv er kontrolleret imod: en ny fejlstatus kan ikke tages i brug, uden at den står her. Brug det fx til at bygge din egen retry-logik eller til at vise en forståelig besked.

Hver post har status, en stabil type, en kort engelsk title, en dansk beskrivelse, retry (nej, retry-after, backoff eller senere), taeller_i_kvote, et eksempel på fejlteksten og besked — den korte besked på dansk og engelsk, som et fejlsvar af typen bærer i message. Et fejlsvar har samme type som posten her, så du kan slå det op direkte. Svaret må caches i en time.

Godkendelse · Åbent

Kræver ingen nøgle. Kaldet er begrænset pr. IP-adresse.

Afregning

Gratis og uden nøgle; begrænset til 60 kald i minuttet pr. IP-adresse.

Eksempel

curl "https://api.grundfast.dk/v1/errors"
Svar · eksempel, forkortet200
{
  "antal": 26,
  "fejl": [
    {
      "status": 400,
      "type": "invalid_request",
      "title": "Bad Request",
      "beskrivelse": "Ugyldig forespørgsel: forkert BFE- eller UUID-format, en manglende eller for kort parameter, et koordinat uden for Danmark, en ugyldig `asOf`, `srid`, `cirkel` eller `polygon`, eller et body, der ikke passer til skemaet. `message` siger på dansk, hvad der er galt, og `param` og `hint` peger på parameteren og rettelsen, hvor vi kan se den (fx `lng` i stedet for `lon`, byttede koordinater, decimalkomma eller et BFE-nummer med punktummer). Et 400-svar tæller ikke i kvoten.",
      "retry": "nej",
      "taeller_i_kvote": false,
      "eksempel": "invalid BFE number",
      "besked": {
        "da": "Forespørgslen er ugyldig. Ret parametrene og prøv igen.",
        "en": "The request is invalid. Fix the parameters and try again."
      }
    },
    {
      "status": 401,
      "type": "invalid_api_key",
      "title": "Unauthorized",
      "beskrivelse": "Nøglen mangler, er ugyldig, udløbet eller tilbagekaldt. `code` skelner: `api_key_missing` (ingen nøgle sendt), `api_key_invalid` (nøglen kendes ikke) og `api_key_wrong_header` (nøglen blev sendt i fx `X-API-Key`, som ikke læses — send `Authorization: Bearer <nøgle>`). Svaret bærer en `WWW-Authenticate`-header og et `hint`, der beskriver formatet.",
      "retry": "nej",
      "taeller_i_kvote": false,
      "eksempel": "invalid API key",
      "besked": {
        "da": "API-nøglen mangler, er ugyldig eller udløbet.",
        "en": "The API key is missing, invalid or expired."
      }
    },
    {
      "status": 402,
      "type": "plan_required",
      "title": "Payment Required",
      "beskrivelse": "Funktionen eller størrelsen er ikke med i din plan. Batch og webhooks kræver Pro; eksport og historik (`asOf` og `/historik`) kræver Scale. Det samme svar får en batch med flere id’er, end din plan tager pr. kald, og et job med flere rækker, end din plan tager pr. job. Beskeden nævner grænsen og den plan, der skal til — eller at listen kan sendes som et job.",
      "retry": "nej",
      "taeller_i_kvote": false,
      "eksempel": "this feature requires the Pro plan or higher; …",
      "besked": {
        "da": "Funktionen kræver en større plan.",
        "en": "This feature requires a higher plan."
      }
    }
  ],
  "meta": {
    "kilde": "Grundfast",
    "grundfast_version": "0.1.0"
  }
}

Forkortet: lange lister og geometrier er skåret ned — de viste værdier er uændrede.

Felter i svaret

fejl[].statusinteger
HTTP-statussen. Samme status kan have flere fejltyper, fx 429.
fejl[].typestring
Fejltypens stabile nøgle, fx quota_exceeded eller rate_limited.
fejl[].retry'nej' | 'retry-after' | 'backoff' | 'senere'
Om og hvordan du prøver igen: aldrig uændret, efter Retry-After, med eksponentiel backoff, eller når forudsætningen er opfyldt.
fejl[].taeller_i_kvoteboolean
Om et svar af denne type bruger en enhed af månedens kvote.

Statuskoder

StatusBetydning
200Svaret er leveret.
429Mere end 60 kald i minuttet fra samme IP-adresse. Se Retry-After.

Alle fejl har samme form. Byg logikken på type (fejlklassen) og vis message (dansk tekst med årsagen) til brugeren; hint kommer med, når vi kan se, hvad der skal rettes, og request_id er det, support skal bruge. Se Fejl og statuskoder for hver type, og hvad der kan prøves igen.

Fejlsvar · 404
{
  "error": "property not found",
  "type": "not_found",
  "code": "not_found",
  "message": "Ressourcen findes ikke.",
  "request_id": "6cbfa45a-a9ea-4140-9d42-ea752a70ff1f",
  "doc_url": "https://grundfast.dk/docs/fejl#not_found"
}

Prøv det

Live-kald fra siden

Åbent endpoint

Endpointet er åbent — kaldet sendes uden nøgle.

GET /v1/errors

Bruges ofte sammen med