Hoppa till huvudinnehåll

Översikt över CertiDrives öppna API

CertiDrive har ett arbetsyteisolerat REST-API för registreringsposter och ett separat ERP-flöde för hela kedjan eCoC, RDW och eReKo.

Skrivet av Anton Hjalmarsson

Fullständig API-dokumentation

Endpoints, autentisering, exempel på anrop och svar, felkoder och miljöer finns på certidrive.apidocumentation.com.

För att använda API:et behöver ni ett aktivt CertiDrive-konto, en API-nyckel och, för registreringar, att företaget är godkänt hos Transportstyrelsen.

API:er

Publikt registrerings-API
Basadress: https://api.certidrive.se

  • GET /v1/registrations listar registreringar. Parametrar: limit (högst 200), offset, status och vin.

  • GET /v1/registrations/{id} hämtar en registrering.

  • POST /v1/registrations skapar en intern registreringspost med de tillåtna fälten vin, owner, reg_number och data.

ERP eCoC-API
Basadress: https://api.certidrive.se

  • POST /v1/ecoc-registrations startar eCoC-kedjan. Headern Idempotency-Key krävs.

  • GET /v1/ecoc-registrations/{job_id} hämtar jobbstatus.

  • GET /v1/ecoc-registrations?external_reference=<er referens> hittar jobb via ERP:ets egen referens.

  • POST /v1/ecoc-registrations/{job_id}/retry återupptar ett stoppat jobb.

  • POST /v1/ecoc-registrations/{job_id}/resolve registrerar vad en kontroll i eReKo visade när svaret från Transportstyrelsen uteblev.

  • GET /v1/ecoc-registrations/{job_id}/ecoc hämtar den eCoC-fil som RDW godkände.

  • POST /v1/ecoc-registrations/validate kontrollerar ett anrop utan att något sparas eller skickas.

  • GET /v1/template-fields listar mallens värden som ecoc_fields kan ersätta, med typ och tillåtna värden från IVI-XSD:n.

  • GET /v1/profiles listar arbetsytans registreringsprofiler.

  • GET /v1/readiness visar om certifikat, mall, profiler och webhook är klara i nyckelns miljö.

  • GET /v1/openapi.json är en maskinläsbar beskrivning av hela ERP-API:t (OpenAPI 3.1). Den kräver ingen nyckel och kan importeras i till exempel Postman.

Autentisering

Skicka API-nyckeln i x-api-key. Det publika registrerings-API:t accepterar även Authorization: Bearer <nyckel>. Nyckeln identifierar både arbetsyta och miljö och begränsas av valda scopes.

Viktigt att veta

POST /v1/registrations skapar bara en intern post. Det skickar inte uppgifterna till Transportstyrelsen. Använd ERP eCoC-API:t eller ett arbetsflöde i CertiDrive för myndighetssändning.

Scopes stock:* och registrations:status kan väljas i nyckelvyn, men den aktuella publika API-funktionen exponerar bara registreringsrutterna ovan. Bygg inte en integration mot en route som inte finns dokumenterad och verifierad.

Fick du svar på din fråga?