API token flow diagram

Nedenstående sekvensdiagram viser det flow der sker når en anvender skal kalde Video API’er.

sequenceDiagram
    participant WSC as Anvender (WSC)
    participant STS as Security Token Service (STS)
    participant WSP as Video API (WSP)

    autonumber

    activate STS
    WSC->>STS: bestil token (certifikat) - SOAP
    STS-->>WSC: returner SAML token
    deactivate STS

    activate WSP
    WSC->>WSP: autentificer (SAML token) - REST
    WSP-->>WSC: returner session id
    WSC->>WSP: kald API (session id) - REST
    WSP-->>WSC: Svar fra API
    deactivate WSP

I ovenstående eksempel er det Video API servicen der er anvendt som eksempel og derfor URL’er til Video API servicen der refereres til. Er det en anden service skal kaldes er det andre URL’er der skal anvendes.

1. Anvender beder STS’en om at udstede et SAML token. Dette sker via et SOAP kald. For at STS’en kan udstede et SAML token skal klienten være konfigureret i STS’en med et certifikat samt andre oplysninger om anvender. STS’en kan tilgås på https://sts.vconf.dk/sts/service/sts og dens WSDL kan tilgås på https://sts.vconf.dk/sts/service/sts?wsdl.
2. Er klienten konfigureret i STS’en og anvender klienten det rigtige certifikat udsteder STS’en et SAML token og returnerer dette til anvender.
3. Det returnerede SAML token i punkt 2 postes til Video API servicen. Det sker på https://videoapi.vconf.dk/videoapi/token
4. Der returneres et session id som skal anvendes når Video API servicen skal kaldes. Det samme session id kan anvendes indtil det ikke længere gyldigt. Dermed sparer man kaldende i punkterne 1-4.
5. Selve kaldet til Video API’et laves. Session id medsendes som en HTTP header. Hvis man f.eks. ønsker at oprette et møde sker det ved HTTP POST kald til https://videoapi.vconf.dk/videoapi/meetings
6. Video API’et svarer tilbage.

Det returnerede SAML token i punkt 2 udløber, som standard, efter 8 timer. Hvornår et givent token pæcist udløber er angivet i svaret fra STS servicen.