Rest tjenester for FS

URL til tjenester

FSWS jobber mot to ulike servere, TEST og PROD.

TEST-server er https://fs-test.uio.no

PROD-server er https://fsws.usit.no

Versjon

Gjeldende versjon av FSWS-REST kan slås opp med:

Test: https://fs-test.uio.no/fsrest/Versjon
Prod: https://fsws.usit.no/fsrest/Versjon

Tilgjengelige tjenester

• FS-API v1
• BAS-tjenester (Brukeradministrasjon)
• BRIS-tjenester (Utveksling til Studentsamskibnad)
• CDM-tjenester (Kursdata til utdanning.no)
• CRUD-tjenester (Direkte oppdatering av enkelttabeller)
• DIGEKS-tjenester (Digital eksamen)
• FEIDE CONNECT-tjenester (Eksport av grupper og medlemsskap til Feide Connect)
• Hovedbokføring (Overføring til økonomisystem)
• SEMREG-tjenester (Semesterregistrering og studentkort)
• STUDINFO2-tjenester (Tjenester for å hente ut studie-info)
• STUDRAPP-tjenester (Tjenester for Lånekassen og timeplanlegging)
• Institusjonsregisteret
• GAUS-integrasjonen
• Public360 

Les mer om rest her.

Hvordan kommer jeg igang med å teste REST-tjenester?

For å komme igang så trenger du å ha et brukernavn og et passord. Dette må bestilles gjennom FS-kontakten på institusjonen du skal lage integrasjon mot. Den personen godkjenner behovet og sender mail til "fs-support@fsat.no" med følgende opplysninger:

• Om det er en ekstern leverandør som vil ha tilgang, i så fall navn på leverandør.
• Navn og mobilnummer til kontaktperson
• Hvilke tjenester som man ønsker å benytte

Når dette er gjort kan man sette igang å teste.

FS-rest opererer med to ulike URL'er, en for TEST og en for PROD:

• TEST: https://jboss-test.uio.no/fsrest/rest/<tjeneste>
• PROD: https://fsws.usit.no/fsrest/rest/<tjeneste>

Det er ulike fremgangsmåter for å teste REST-tjenestene

• Rett i browser (se eksempel her)
• Program som f.eks. Advanced Rest Client(se eksempel her)
• Hjemmesnekret (se Java-eksempel her)

Hvordan bestiller jeg nye tjenester?

Bestilling sendes til "fs-support@fsat.no". I denne mailen må følgende spesifiseres:

• Type spørring (hente data, oppdatere data)
• Parametre til spørring (fødselsnummer, epost osv...)
• Format på returnerte data (XML, JSON)
• Datafelter som returneres ved spørring

Hva skjer med de gamle tjenestene?

De gamle FSWS-tjenestene (SOAP) vil fortsette å gå. Vi kommer ikke til å utvikle nye tjenester i SOAP, hvis ikke det er tungtveiende argumenter for å gjøre det. Vi ønsker også i fremtiden at SOAP-tjenestene skal fases ut, men her er det ikke bestemt noe enda.

Hva betyr rollebegrepet i denne sammenhengen?

For å begrense tilgang til tjenester, så benytter vi Webservice-roller, et eksempel på dette er "bas-user", som da har tilgang til bas-tjenestene. Når du bestiller tilgang må du samtidig angi hvilke roller som brukeren skal ha. Tilgang er basert på tjenester, så alle tjenestene som er listet under kan det gis tilgang til.

Jeg har nettopp fått tildelt ny rolle på eksisterende bruker, men får fortsatt ikke tilgang, hva skjer?

Brukeroppslaget i FSWS blir cachet for å spare trafikk mot autentiseringsserveren. Derfor vil ikke endringene være synlig umiddelbart. Cachen tømmes hver time, så dersom du venter en drøy time før du prøver så bør alt virke bra.

Teknisk beskrivelse

I URL-beskrivelse er servernavn byttet ut med <server>. Dette må erstattes basert på om vi har produksjon eller test. URL'ene er gitt over.

For GET-tjenestene er parametre spesifisert inne i "{}". Hele denne delen(med {}) skal erstattes med verdi.

Der det er spesifisert "Query-parametre", så spesifiseres dette på følgende måte: http://url?param1=verdi&param2=verdi

All XML er spesifisert i linkede XSD.