MedCom Video API — Quick reference (single-page)¶
Denne side er en komprimeret quick reference til eksterne udviklere der integrerer mod MedCom Video API v2 via Keycloak OAuth2.
For komplet dokumentation med detaljerede endpoint-beskrivelser, modeller, flows og fejlhåndtering, se den fulde guide.
Målgruppe¶
Tredjeparts-systemer der skal oprette, søge, opdatere og slette videomøder, samt læse scheduling information og templates via MedCom Video API.
Kald API'et med brugerens OAuth2 access token fra VDX Keycloak. Token skal indeholde organisation, email og mindst én gyldig meeting-rolle.
Forudsætninger¶
- Aftale med MedCom om Keycloak-klient og adgang til Video API — kontakt
vdx@medcom.dk. Se adgangsvejledning. - Brugeren skal have organisation og email i token — ellers afvises create/update.
- Brug v2-endpoints (
/v2/...). v1 er under udfasning. - CORS-whitelist hos MedCom hvis browseren kalder API'et direkte.
Authentication (essens)¶
- Log brugeren ind via Authorization Code Flow (evt. med PKCE) mod VDX Keycloak.
- Modtag
access_token. - Send i alle Video API-kald:
Påkrævede JWT-claims¶
| Claim (konfigurerbart navn) | Beskrivelse |
|---|---|
userservice.token.attribute.organisation |
Brugerens organisation |
userservice.token.attribute.email |
Brugerens email |
userservice.token.attribute.userrole |
Mindst én meeting-rolle |
Claim-navne aftales typisk med MedCom ved adgangsanmodning.
Base URLs og endpoints (v2)¶
| Miljø | Base URL |
|---|---|
| Stage | https://videoapi.vconf-stage.dk |
| Produktion | https://videoapi.vconf.dk |
| Metode | Route | Formål |
|---|---|---|
| GET | /v2/info |
Health/info — test at API svarer |
| GET/POST | /v2/meetings |
Søg/opret møder |
| GET/PUT/PATCH/DELETE | /v2/meetings/{uuid} |
Hent/opdater/slet møde |
| GET | /v2/scheduling-info |
Søg scheduling info |
| GET | /v2/scheduling-info/{uuid} |
Hent scheduling info |
| GET | /v2/scheduling-info-reserve |
Reservér scheduling info fra pool |
| GET/POST/PUT/DELETE | /v2/scheduling-templates |
Admin: templates |
| GET | /v2/pool |
Pool-status pr. organisation |
Roller (essens)¶
| Rolle | Typisk ansvar |
|---|---|
meeting-user |
Egne møder |
meeting-planner |
Møder i egen organisation (evt. på vegne af andre via organizedByEmail) |
meeting-admin |
Alt ovenstående + scheduling templates og pool-reservation |
Se Roller og adgang.
Opret møde (essens)¶
curl -s -X POST "https://videoapi.vconf-stage.dk/v2/meetings" \
-H "Authorization: Bearer DIT_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"subject": "Patientkonsultation",
"startTime": "2026-06-28T10:00:00Z",
"endTime": "2026-06-28T10:30:00Z",
"description": "Opfølgning"
}'
Responsen indeholder uuid, shortId, shortLink og HAL _links til scheduling info.
Timestamp-format (v2)¶
- Input: ISO 8601 med offset, fx
2026-06-28T10:00:00Zeller2026-06-28T12:00:00+02:00 - Output: Samme format med offset
- Sekundbrøkdele i input ignoreres
Se v1/v2-forskelle.
Fejl (essens)¶
| HTTP | Typisk årsag |
|---|---|
| 400 | Manglende/ugyldigt input, unikt felt i konflikt |
| 401 | Manglende/ugyldig token eller forkert rolle |
| 403 | Møde tilhører ikke brugerens organisation |
| 404 | UUID/id findes ikke |
| 406 | Ugyldig provisionStatus for operation |
Fejl-body: detailedError med errorCode og errorText. Se Fejlkoder.
OpenAPI / SwaggerHub¶
Fuld kontrakt: https://api-docs.vconf.dk/videoapi/v1/videoapi/
Support¶
- Email:
vdx@medcom.dk - Support-side
Se også¶
Ændringshistorik¶
| Dato | Ændring |
|---|---|
| 2026-06-27 | Første quick reference for MedCom Video API |