Informasjonsside API

Generelt


Vi har opprettet et REST API for å tilgjengeliggjøre resultater fra våre beregningsverktøy. Under vises fremgangsmåte/beskrivelse for å bruke API'en for 'Seniorkalkulatoren'.

'Seniorkalkulator'

Endepunkt

Basis-URL til endepunktet for kalkulatoren er:

Merk spesielt versjonsangivelsen; 'v0', som kan endre seg ved lansering av eventuelle nye versjoner.

Parametere

I tillegg til basis-URL kreves det 5 parameterverdier i forespørselen, inkludert som egne segmenter i adressen. Verdiene som inkluderes representerer parameterne listet i tabellen under. Parameternavn skal ikke med i URL'en, men rekkefølgen må holdes ('attribute-routing'):

Boligverdi  
Eventuell fellesgjeld Dersom denne sendes med verdi større enn 0, antas bolig å være i borettslag
Alder på søker  
Alder på eventuell medsøker Sendes med verdi 0 dersom medsøker ikke er aktuelt
Postnummer Postnummer for boligens adresse

Se eksempler lenger ned for konkret oppbygning.

Autorisasjon

For at forespørselen skal godkjennes i endepunktet, må det inkluderes en nøkkel/et token i HTTP-headeren. Navnet på denne må settes til 'APIKey', og for demonstrasjonsformål kan verdien settes til '7c842e4d6ae0b6756aaf8c9e70af20b8'.


Respons

Resultatet av forespørselen leveres som et JSON-objekt, med to delobjekter:

Beregningsresultat    
  Engangsutbetaling (number)
  Fastutbetaling (number)
Forutsetninger    
  ErBorettslag (string 'true'|'false')
  HarMedsoker (string 'true'|'false')
  Poststed (string)
  API-Klient (string)

Eksempel

Boligverdi 4 000 000, ikke borettslag, låntaker på 60 år, ingen medlånstaker, bolig i Flekkefjord kommune (postnummer 4400):