01. Integrasjonsprinsipper

Jump to bottom Edit New page

Thor Kristian Valderhaug edited this page May 12, 2021 · 7 revisions

HTTP-basert API

Ressursbasert
Maskin-til-maskin kommunikasjon
Platformuavhengig
"Pragmatisk" REST (Representational State Transfer) (Level 2 Richardson Maturity Model)
Referanseimplementasjoner tilgjengelig [her] (https://github.com/Utdanningsdirektoratet/PAS2-Public/tree/master/ExampleClients)

Eksempel:
GET https://eksamenapi.udir.no/sas/eksamensplan
200 OK XML struktur i payload

Skjemavalidering av innkommende data

XML Well-formedness
XML Schema definition (XSD)
Ressurser vil returnere statuskode 400 ved valideringsfeil og sende tilbake en JSON/XML med detaljer om hva som gjorde at valideringen feilet

Asynkron prosessering

Større oppgaver, eksempelvis kandidatpåmeldinslister, prosseseres asynkront hvor klient kan etterspørre status ved hjelp av oppgavereferanse (task reference).

POST https://eksamenapi.udir.no/sas/kandidatpåmelding (XML påmelding payload)
202 Accepted TaskRef: xyzabc

GET https://eksamenapi.udir.no/sas/kandidatpåmelding/status/xyzabc
200 Ok Status: InProgress/Done/Error