Dokumentasjon og utprøving av tjenestene

FS-API kan utforskes i Swagger: 

Utvikling:         https://fsapi-utv.uio.no/swagger.html
Test/Demo:     https://fsapi-test.uio.no/swagger.html
Prod:              https://api.fellesstudentsystem.no/swagger.html

 

Dokumentasjon ligger på hver enkelt resssurs og på linken øverst i vinduet

 

Autentisering - hent token

Man må først autentisere seg og deretter hente token: Klikk på 'Authorize'

Logg på med brukernavn og passord - deretter 'close'

Åpne lamellen JWT jsonweb Token

Trykk 'Try it out' og deretter 'Execute'

Man får da returnert en token-streng. Denne skal du markere  og kopiere (uten fnutter ")

 

Tokenet limes inn nederst i dialogen som gjenåpnes med 'Authorize' .

Du er nå klar til å kjøre de enkelte tjenestene. Når man åpner en lamell, får man beskrevet de ulike parametrene tjenesten tar.

Velg 'Try it out' for å legge inn parametre/filtre, og utfør kall gjennom å trykke 'Execute'. Swagger viser da fram hvilken ' Request url' som sendes inn i dette tilfellet, og hvilken 'Respose body' api-et gir som retur for dette kallet.

 

 

Publisert 22. des. 2017 10:50 - Sist endret 28. mars 2022 17:52