Page tree
Skip to end of metadata
Go to start of metadata

Innledning

Dette dokumentet beskriver hvordan systemer kan integrere seg med Simployer.

Det er lagt vekt på å beskrive både det funksjonelle aspektet i forhold til hva integrasjonene tilbyr rent funksjonelt og en teknisk detaljering av grensesnittene som tilbys av Simployer.

Versjonering av operasjoner

Flere av operasjonene og entitetene i dette dokumentet vil kunne eksistere i flere versjoner. Dette for å være tilbakekompatibel med eventuelt eksisterende klienter. Når en endring blir gjort for en gitt operasjon opprettes det en ny operasjon med tilsvarende navn som ender med et versjonsnummer, for eksempel V2. Dette gjør at gamle klienter vil kunne fortsette å benytte gammel metode og WSDL, mens nye klienter kan (og oppfordres til) å benytte nyeste metode og WSDL.

Merk at ikke alle grensesnitt nødvendigvis vil benytte denne endelsen. Dette gjelder i de tilfeller hvor operasjonen ikke tidligere er tilgjengeliggjort og dermed ikke har noen forgjenger.

Dette dokumentet vil dokumentere den nyeste versjonen av operasjonene. For dokumentasjon av tidligere versjoner henvises det til tidligere dokumentversjoner.

Webtjeneste endepunkter og protokoller

Alle webtjenestene har 2 forskjellige endepunkter:

  • Operasjoner som benytter SOAP 1.1 er kjennetegnet med at adressen ender på Basic.
  • Operasjoner som benytter SOAP 1.2 er kjennetegnet med adressen ender på Ws.

Definisjoner

Betegnelse

Beskrivelse

Autentisering

En betegnelse på det å verifisere en bruker eller et systems identitet. Dette vil typisk skje ved en sjekk av brukernavn og passord og/eller pin kode stemmer overens med registrert informasjon.

Autorisasjon

En betegnelse på å verifisere at en gitt identifisert bruker eller system identitet har rettigheter til å utføre en handling eller har rettigheter i forhold til spesifikke data.

SOAP

Uavhengig protokoll spesifikasjon for utveksling av strukturert informasjon gjennom web services.

Web service

Tjeneste på Internet aksessert vha. HTTP/HTTPS (som oftest) som utfører en bestemt oppgave, eller en bestemt type oppgaver. I dette dokumentet benyttes begrepet webtjeneste.

WSDL

Språk (xml) som beskriver en web service, dvs. informasjon om tjenester, protokoller og formater. Hensikten er å ha en velkjent måte for å etablere dialog mellom brukere og tilbydere av elektroniske tjenester.

XML

EXtended Markup Language - XML er en språkdefinisjon for strukturering og beskrivelse av data.

XSD

XML Schema. Metabeskrivelse for XML data. Beskrivelse av hvordan XML dataene skal være strukturert og beskrivelse av alle data elementene. Blir også brukt til å validere XML data.

Autentisering og autorisasjon

Autentisering skjer ved at det oppgis et brukernavn og et passord for en eksisterende bruker (person) i Simployer. Autorisasjonen foregår ved at systemet kontrollerer denne brukerens roller. Brukeren må ha rollen Systemadministrator for de fleste operasjoner.

  • No labels