View Maintenance - OpenAPI med Swagger Web- grensesnitt

View Maintenance OpenAPI er konfigurert med Swagger web- grensesnitt, som tilbyr et interaktivt grensesnitt for å test kjøre tjenestene.

Nedenfor følger en kort veiledning for å komme i gang med Swagger- grensesnittet.

Eksemplet viser endepunkt for den offentlige demo- løsningen. Ta kontakt dersom du ønsker en API- bruker for å teste integrasjon mot View Maintenance.

Authentisering

Før man kan teste tjenestene, må man hente et token. Dette gjør man vet å kalle (POST) APIToken- tjenesten med brukernavn/passord (ref. bilde).

Ekspander APIToken og velg "Try it out".

Velg "Execute" – Token skal nå vises i "Response body" vindu.

Kopiere hele token strengen (uten anførselstegn) og lim denne inn i dialogen som kommer opp når man velger "Authorize"- knappen helt øverst til høyre på siden.

OBS! Før man limer inn token, må man skrive "Bearer " i Value: feltet (se bilde nedenfor).

Velg "Authorize" og "Close"

Token, som har en begrenset levetid (30 min.), blir lagt inn på alle forespørsler som gjøres fra web- grensesnittet.

Test en tjeneste

Kontrollen "Asset" tilbyr en tjeneste for å hente ut detaljer for en Asset (Get Asset by AssetID).

Ekspandere linjen og velg "Try it out"

Angi assetId 15 og trykk "Execute".

Dersom autentiseringssteget over var vellykket, vil denne forespørselen returnere detaljer for asset med Id 15.

API- brukeren har tilgang til samtlige kontroller i API'et, og man kan selvfølgelig teste tjenestene med andre Rest- Client verktøy (Postman, Insomnia etc.).