Endpoints¶

Alle endpoints nedenfor er apikey-sikrede og relative til base URL. Kun GET-operationer.

Base URLs¶

Miljø	Base URL
Stage	`https://historyapi.vconf-stage.dk`
Produktion	`https://historyapi.vconf.dk`

Eksempel: GET https://historyapi.vconf-stage.dk/apikey/status/v1/conference/list

Fælles headers¶

Header	Påkrævet	Beskrivelse
`X-API-KEY`	Ja	API-nøgle oprettet i VDX Management (`management-admin`)

Endpoint-oversigt¶

Live-status¶

Metode	Route	Formål
GET	`/apikey/status/v1/conference/{uri_with_domain}`	Live-status for specifik konference
GET	`/apikey/status/v1/conference/list/{group_id}`	Live-status for alle konferencer i gruppe
GET	`/apikey/status/v1/conference/list`	Live-status for alle tilgængelige konferencer

Historic¶

Metode	Route	Formål
GET	`/apikey/history/v1/conference`	Historiske konferencer (datointerval)
GET	`/apikey/history/v1/conference/{conference_id}`	Historisk konference via ID

GET /apikey/status/v1/conference/{uri_with_domain}¶

Hent live-status for en specifik konference identificeret via URI med domæne.

Request¶


Method	GET
Path	`/apikey/status/v1/conference/{uri_with_domain}`
X-API-KEY	Påkrævet

Parameter	Type	Beskrivelse
`uri_with_domain`	string (path)	Konference-URI med domæne, fx `123456@video.domain`

Eksempel (curl)¶

curl -s -X GET "https://historyapi.vconf-stage.dk/apikey/status/v1/conference/123456%40video.domain" \
  -H "X-API-KEY: DIN_API_NOEGLE"

Response (200 OK)¶

Returnerer en live-conference-struktur.

Fejl¶

HTTP	Årsag
404	Konference findes ikke eller er ikke aktiv

GET /apikey/status/v1/conference/list/{group_id}¶

Hent live-status for alle aktive konferencer i en specifik gruppe.

Request¶

Parameter	Type	Beskrivelse
`group_id`	integer (path)	VDX gruppe-ID

Eksempel (curl)¶

curl -s -X GET "https://historyapi.vconf-stage.dk/apikey/status/v1/conference/list/12345" \
  -H "X-API-KEY: DIN_API_NOEGLE"

Response (200 OK)¶

Array af live-conference.

GET /apikey/status/v1/conference/list¶

Hent live-status for alle konferencer API-nøglen har adgang til.

Eksempel (curl)¶

curl -s -X GET "https://historyapi.vconf-stage.dk/apikey/status/v1/conference/list" \
  -H "X-API-KEY: DIN_API_NOEGLE"

Response (200 OK)¶

Array af live-conference.

GET /apikey/history/v1/conference¶

Hent historiske konferencer for organisationens hierarki i et datointerval.

Request¶

Parameter	Påkrævet	Type	Beskrivelse
`start_time__gte`	Ja	datetime	Start af periode (ISO 8601)
`end_time__lt`	Nej	datetime	Slut af periode (ISO 8601)
`limit`	Nej	integer	Max antal resultater

Eksempel (curl)¶

curl -s -G "https://historyapi.vconf-stage.dk/apikey/history/v1/conference" \
  -H "X-API-KEY: DIN_API_NOEGLE" \
  --data-urlencode "start_time__gte=2026-06-01T00:00:00" \
  --data-urlencode "end_time__lt=2026-06-30T23:59:59" \
  --data-urlencode "limit=100"

Response (200 OK)¶

Array af historic-conference.

Fejl¶

HTTP	Årsag
400	Manglende/ugyldig parameter
401	Ugyldig eller manglende API-nøgle
403	Adgang nægtet for organisation
501	Parameterkombination understøttes ikke

GET /apikey/history/v1/conference/{conference_id}¶

Hent en specifik historisk konference via ID.

Request¶

Parameter	Type	Beskrivelse
`conference_id`	string (path, UUID)	Konference-ID

Eksempel (curl)¶

curl -s -X GET "https://historyapi.vconf-stage.dk/apikey/history/v1/conference/8583f400-7886-48c9-874b-5fefc2ac097e" \
  -H "X-API-KEY: DIN_API_NOEGLE"

Response (200 OK)¶

En historic-conference-struktur.

Fejlkoder¶

HTTP	Betydning
400	Manglende/ugyldigt input, parameter overskrider max længde
401	Ugyldig eller manglende API-nøgle
403	Data tilhører ikke API-nøglens organisation, eller utilstrækkelige rettigheder
404	Ressource findes ikke (konference/deltager slettet eller aldrig eksisteret)
501	Parameterkombination understøttes ikke

Fejlrespons kan indeholde basicError eller detailedError.

Anbefalet klient-adfærd¶

Status	Handling
`400`	Ret query-parametre
`401`	Tjek API-nøgle; kontakt admin hvis ugyldig
`403`	Vis adgangsfejl; foretag ikke retry
`404`	Håndter som "ingen data"
`501`	Juster parameterkombination

Se også¶

Ændringshistorik¶

Dato	Ændring
2026-06-27	Rettet base URL til `historyapi.vconf.dk` / `historyapi.vconf-stage.dk`
2026-06-27	Første endpoint-reference for VDX Pexip History Service