Guide
Versionering
Se vilka förändringar som är bakåtkompatibla och när en ny API-version krävs.
API-versionen är en del av sökvägen, exempelvis /api/v1/. Alla resurser under samma version följer reglerna på den här sidan.
Bakåtkompatibla ändringar
- Nya resurser kan tillkomma.
- Befintliga JSON-objekt kan få nya fält.
- En resurs kan få fler valfria parametrar.
- Listor med koder kan få nya värden, till exempel en ny status eller felkod.
Bygg klienten så att okända JSON-fält ignoreras och okända kodvärden kan hanteras utan att hela integrationen stoppas.
Ändringar som kräver en ny version
- Ett befintligt fält tas bort eller får ett nytt namn.
- Datatypen eller den etablerade betydelsen för ett fält ändras.
- Svaret får en annan övergripande struktur.
- Tidigare giltiga anrop börjar avvisas på grund av striktare validering.
Ändringar på grund av lag eller källa
En datakälla, lagändring eller tillsynsmyndighet kan kräva att ett fält slutar distribueras. Det gäller särskilt personuppgifter. Om en sådan situation uppstår kontaktar vi registrerade integrationsägare så snart som möjligt.
Den aktuella maskindefinitionen finns på /api/v1/openapi.json. Filen genereras av samma applikation som hanterar anropen och är därför den tekniska sanningskällan.