Testnøgle

To slags nøgler

Alle data-endpoints kræver en API-nøgle i Authorization-headeren som Bearer. Der findes to slags. En live-nøgle, gf_live_…, er til produktion: kaldene tæller mod planens månedskvote, og overforbrug faktureres på de betalte planer. En testnøgle, gf_test_…, er til udvikling, CI og staging: den giver de samme rigtige data, men kaldene faktureres aldrig.

Testnøglen er ikke en demo med opdigtede svar. Det er de samme registre og det samme svar, så en parser, der virker mod en testnøgle, virker også i produktion. Til gengæld har testnøgler deres eget loft på 25.000 kald pr. måned, uanset plan, og samme burst-grænse som planen. Ved loftet svarer API’et 429 med besked om at bruge en live-nøgle i produktion.

Sådan kender du forskel

Præfikset står i selve nøglen, og hvert svar bærer headeren X-Grundfast-Environment med værdien live eller test. Log headeren i din integration, så du kan se, hvilken nøgle et miljø faktisk kører med.

Det skal du vide som udvikler

• Nøglen vises kun én gang. Den oprettes i dashboardet, og vi gemmer kun en hash af den. Kopiér den med det samme.
• Hold nøglen på serveren. En nøgle i browserkode kan læses af alle; lad din backend kalde API’et.
• Én nøgle pr. miljø. Giv CI, staging og produktion hver sin nøgle, så du kan tilbagekalde netop den, der er sluppet ud.
• Testnøgler kan altid oprettes. Oprettelse af en live-nøgle kan kræve, at din e-mailadresse er bekræftet.

Kan du ikke sætte en header — fx i et kortbibliotek, der selv henter tiles — kan nøglen sendes som ?token=. En URL havner i logs og historik, så giv en sådan URL sin egen nøgle. Detaljerne står i Godkendelse og nøgler.