API Funktioner

Video API og relaterede services anvender alle et RESTful API (https://en.wikipedia.org/wiki/Representational_state_transfer). 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 forspø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 (https://en.wikipedia.org/wiki/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 formattet 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.

Parametre

Hvilke parametre der kan anvendes til de enkelte API kald er specificeret i API dokumentationen for de enkelte services.

Fejlkoder

Hvilke fejlkoder der anvendes i forbindelse med de enkelte API kald er beskrevet i dokumentationen for disse. De koder der typisk anvendes er HTTP 200, 401, 403 og 404.

API beskrivelser

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

API beskrivelser findes på nedenstående adresser.

Service URL til API dokumentation i PROD miljøet
VideoAPI service https://api-docs.vconf.dk/videoapi/v1/videoapi/
SMS service https://api-docs.vconf.dk/videoapi/v1/sms/
Audit service https://api-docs.vconf.dk/videoapi/v1/audit/
Status service https://api-docs.vconf.dk/videoapi/v1/statistics/

API addresser

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

Service Adresse
STS WSDL https://sts.vconf.dk/sts/sts.wsdl
STS API https://sts.vconf.dk/sts/service/sts
VideoAPI service https://videoapi.vconf.dk/videoapi
VideoAPI authentication https://videoapi.vconf.dk/videoapi/token
SMS API service https://videoapi.vconf.dk/sms/v1/meeting
Audit API service https://videoapi.vconf.dk/audit/v1/audit
Status service https://statusapi.vconf.dk/v1