API-vejledninger

API-Funktioner

Video API og relaterede services anvender alle et RESTful API. Det betyder, at der anvendes gængse HTTP-metoder som f.eks. GET og POST til at beskrive, om det er en læse eller skriveoperation. Ligeledes anvendes der gængse HTTP-statuskoder til at indikere om forespørgslen gik godt eller skidt.

Adgang sker via HTTPS og services er beskyttet af OIO IDWS REST. Se sikkerhedsprotokollen for yderlige information omkring sikkerhed.

Dataformat

API’erne anvender JSON og anvendere skal sætte HTTP-headeren Content-Type til application/json og skal som minimum acceptere application/json i Accept headeren.

Der anvendes to formater til datoer. Det er enten standard open api date-time format (RFC3339, sektion 5.6) eller i formatet 2021-08-17T10:20:23 +0200.

I Java svarer det til følgende pattern yyyy-MM-dd'T'HH:mm:ss Z. Hvilket format der skal anvendes er beskrevet i API dokumentationen for de enkelte services.

API-dokumentation

Alle API’er er beskrevet ved hjælp af Swagger/OpenAPI.

API dokumentation findes på nedenstående adresser.

API adresser

Nedenstående er endpoints for de forskellige API’er i PROD miljøet.