API och nycklar — Dokumentation

Tillgång genom avtal

Kommunlicens Premium och Koncern Enterprise omfattar API med egen organisationsnyckel. API-åtkomst kan också ingå i en avtalad Data-leverans. Kommunlicens Standard och Plus omfattar inte API-nycklar.

När organisationen har ett aktivt avtal med API-åtkomst kan en organisationsadministratör skapa och hantera nycklar under API-nycklar. Övriga medlemmar kan inte skapa nycklar. Er organisation får instruktioner och villkor för det avtalade användningsfallet.

Vid rotation fungerar den gamla nyckeln i högst sju dagar. Om dess ordinarie giltighetstid går ut tidigare slutar den fungera då. Byt nyckel i integrationen före den tidigaste av dessa tidpunkter.

Hämta data

• Öppna CSV-nedladdningar är den publika maskinläsbara vägen.
• Öppen data beskriver källor, licens och kända begränsningar.
• API-roadmap beskriver det fristående API-erbjudandet. Organisationens avtalade API-åtkomst hanteras under API-nycklar.
• Behöver du återkommande datauttag kan du kontakta info@skolspegeln.se för att diskutera Data- eller Enterprise-leverans.

Privat pilot

Utöver paketens API-åtkomst kan en separat privat pilot avtalas för ett särskilt integrationsbehov. En sådan pilot är begränsad till ett avtalat användningsfall, ett tydligt databehov och separata villkor för volym, support, säkerhet och uppsägning. Pilotdokumentation delas direkt med deltagande organisationer och publiceras inte som allmän produktdokumentation.

Tak för organisationens API-nycklar

• Varje nyckel får göra högst 100 anrop per minut.
• Organisationens nycklar delar en månadskvot: 50 000 anrop per kalendermånad med Kommunlicens Premium och 10 000 med övriga paket, om inte avtalet anger ett annat tak.
• När 80 % av månadskvoten är förbrukad försöker vi mejla organisationens administratörer, högst en gång per månad och om personuppgiftsbiträdesavtalet tillåter det. Mejlet är en förvarning, inte en garanti; vid ett lyckat autentiserat dataanrop anger svarshuvudet X-Quota-Remaining hur mycket som återstår.
• När kvoten är slut svarar API:t 429 Monthly API quota exceeded tills kvoten nollställs den första dagen i nästa månad (UTC).