API för Spelpaus.se är ett REST-baserat API där licenshavare ska kontrollera om en person är avstängd från spel.
Spelpaus.se har två huvudsakliga API:er; inloggnings-API och marknadsförings-API. Vilket API som ska användas beror på vilken typ av förfrågan som ska göras. Mer information om respektive API finns i menyn till höger.
Observera att tester inte får utföras mot produktions-API:et.
Anslutningsuppgifter till produktions-API skickas till licenshavarens kontaktperson vid licensgivning.
Identifiering och autentisering
Identifiering och autentisering är samma för samtliga API-endpoint. Identifiering sker via actorId i URL-adressen. Autentisering sker genom API-key i authorization-headern i API-anropet.
För ett korrekt anrop returneras med statuskod 200 och svaret isBlocked sätts till true (avstängd) eller false (ej avstängd).
För ett anrop med felaktig actorId eller en felaktig API-key returneras statuskod 401 (Unauthorized).
Personnummer
Formatet på personnumret (subjectId) ska anges med 12 tecken i formatet ÅÅÅÅMMDDXXXX.
Om subjectID är 12 tecken, men inte ett korrekt personnummer returneras statuskod 200 och isBlocked = false.
Swagger
En teknisk API-specifikation finns publicerad här.