API-referens

TIC Identity API är ett RESTful API som använder JSON för både request och response. Alla anrop kräver autentisering via API-nyckel.

Bas-URL

https://id.tic.io/api/v1

Autentisering

Alla API-anrop kräver en giltig API-nyckel som skickas i X-Api-Key-headern.

curl -H "X-Api-Key: YOUR_API_KEY" \
     https://id.tic.io/api/v1/usage

Skydda din API-nyckel

Exponera aldrig din API-nyckel i klientkod. Alla API-anrop ska göras från din backend.

Endpoints

Autentisering

POST /api/v1/auth/{provider}/start

Startar en ny autentiseringssession.

GET /api/v1/auth/{sessionId}/collect

Hämtar resultat för en avslutad session.

POST /api/v1/auth/{sessionId}/poll

Pollar BankID och returnerar aktuell status.

DELETE /api/v1/auth/{sessionId}

Avbryter en pågående session.

Signering

POST /api/v1/auth/{provider}/sign

Startar en ny signeringssession.

GET /api/v1/auth/{sessionId}/collect

Hämtar resultat för en avslutad signeringssession.

Se fullständig dokumentation för autentisering →

Se fullständig dokumentation för signering →

Svarsformat

Alla svar returneras i JSON-format. Lyckade anrop returnerar HTTP 200 med data. Fel returnerar lämplig HTTP-statuskod med ett felobjekt.

Lyckat svar

{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending",
  "provider": "bankid",
  "qrCodeData": "bankid.67df3090...",
  "autoStartToken": "7c40b5c9..."
}

Felsvar

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required parameter: endUserIp",
    "details": {
      "parameter": "endUserIp",
      "expected": "string (IP address)"
    }
  }
}

Rate limits

API:et har följande rate limits för att säkerställa stabil drift:

Limit	Värde	Beskrivning
Requests per minut	240	Per API-nyckel
Requests per timme	3000	Per API-nyckel
Requests per dag	10000	Per API-nyckel

Rate limit-status returneras i response headers:

X-RateLimit-Limit-Minute: 240
X-RateLimit-Remaining-Minute: 238
X-RateLimit-Limit-Hour: 3000
X-RateLimit-Remaining-Hour: 2987

Felkoder

Se felkodsreferensen för en komplett lista över alla felkoder och hur du hanterar dem.