OS2sofd kan integreres på to måder:
- OData – et read-only API til at udlæse organisations- og identitetsdata.
- REST-API – et API til udvalgte skrive- og udtræks-operationer, dokumenteret via Swagger/OpenAPI.
Begge kræver en API-nøgle.
API-nøgler og adgang#
Adgang sker via en API-nøgle, der oprettes i OS2sofd-administrationen og sendes i
HTTP-headeren ApiKey. En nøgle tildeles ét af tre adgangsniveauer:
- Skriveadgang: læse og skrive.
- Læseadgang: kun læse.
- Begrænset læseadgang: kun læse, og enkelte følsomme endpoints er ikke tilgængelige.
Derudover kan en nøgle begrænses til bestemte afsender-IP-adresser, og for OData kan en nøgles læseadgang afgrænses til bestemte felter.
API’et er under omlægning mod en ny, samlet flade. Se Fremtidig API-udvikling for den vedtagne retning.