Kodeeksempler¶

Eksemplerne dækker typiske integrationsscenarier med curl.

#	Scenarie	Endpoint / handling
1	Hent alle live konferencer	`GET /apikey/status/v1/conference/list`
2	Hent live status for specifik konference	`GET /apikey/status/v1/conference/{uri}`
3	Hent live status for gruppe	`GET /apikey/status/v1/conference/list/{group_id}`
4	Hent historik i periode	`GET /apikey/history/v1/conference`
5	Hent historisk konference via ID	`GET /apikey/history/v1/conference/{id}`
6	Fejlhåndtering	401 / 403 / 404

Forudsætninger i eksemplerne¶

Erstat placeholder-værdier:

Variabel	Beskrivelse
`API_KEY`	API-nøgle oprettet i VDX Management
`HISTORY_API_BASE`	`https://historyapi.vconf-stage.dk` (stage)
`CONFERENCE_ID`	UUID fra historisk konference
`GROUP_ID`	VDX gruppe-ID (integer)

1. Hent alle live konferencer¶

HISTORY_API_BASE="https://historyapi.vconf-stage.dk"
API_KEY="DIN_API_NOEGLE"

curl -s -X GET "${HISTORY_API_BASE}/apikey/status/v1/conference/list" \
  -H "X-API-KEY: ${API_KEY}"

Forventet: HTTP 200 med array af live-conference objekter.

2. Hent live status for specifik konference¶

URI med domæne skal URL-encodes (@ → %40):

curl -s -X GET "${HISTORY_API_BASE}/apikey/status/v1/conference/123456%40video.domain" \
  -H "X-API-KEY: ${API_KEY}"

3. Hent live status for gruppe¶

GROUP_ID=12345

curl -s -X GET "${HISTORY_API_BASE}/apikey/status/v1/conference/list/${GROUP_ID}" \
  -H "X-API-KEY: ${API_KEY}"

4. Hent historik i periode¶

curl -s -G "${HISTORY_API_BASE}/apikey/history/v1/conference" \
  -H "X-API-KEY: ${API_KEY}" \
  --data-urlencode "start_time__gte=2026-06-01T00:00:00" \
  --data-urlencode "end_time__lt=2026-06-30T23:59:59" \
  --data-urlencode "limit=100"

start_time__gte er påkrævet. Brug limit til at begrænse antal resultater.

5. Hent historisk konference via ID¶

CONFERENCE_ID="8583f400-7886-48c9-874b-5fefc2ac097e"

curl -s -X GET "${HISTORY_API_BASE}/apikey/history/v1/conference/${CONFERENCE_ID}" \
  -H "X-API-KEY: ${API_KEY}"

6. Fejlhåndtering¶

401 — ugyldig API-nøgle¶

{
  "timestamp": "2026-06-28T10:00:00",
  "status": 401,
  "error": "Unauthorized",
  "path": "/apikey/history/v1/conference"
}

Handling: Verificér API-nøgle; kontakt organisationens management-admin hvis nøglen er ugyldig eller udløbet.

403 — adgang nægtet¶

Handling: Data tilhører ikke API-nøglens organisations hierarki — vis fejl, foretag ikke retry.

404 — ikke fundet¶

Handling: Konference findes ikke eller er ikke aktiv (live) — håndter som "ingen data".

Se Fejlkoder for komplet oversigt.

Se også¶

Ændringshistorik¶

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