Boligsparing for ungdom API

Sikkerhet

Denne tjenesten støtter både bruk av maskinporten og virksomhetssertifikat. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:boligsparingforungdom

Delegering

Tilgang til denne tjenesten kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen. Søk opp følgende tjeneste i Altinn for å delegere tilgangen: Boligsparing for ungdom API.

Grensesnittbeskrivelse

URL-en har følgede oppbygging:

GET https://<env>/api/innrapportert/boligsparingforungdom/<inntektsaar>/<personidentifikator>

• <env>: Miljø-spesifikk adresse
• <inntektsaar>: Inntektsåret man spør om informasjon for, i formatet YYYY.
• <personidentifikator>: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Versjonering

Se Om versjonering for generelle regler for versjonering.

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.

$ curl -k https://api-at.sits.no/api/innrapportert/boligsparingforungdom/2017/08028830701 --key nøkkel.key --cert sertifikat.cer -XGET -H 'accept: application/json'

Suksess (HTTP status 200)

Dersom kallet lykkes får man HTTP status 200 og data i JSON eller XML format. Dersom man ikke spesifiserer ønsket format får man JSON.

JSON

{
  "personidentifikator": "12345678901",
  "inntektsaar": "2019",
  "aaretsRenter": 100.00
}

XML

Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml:

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/innrapportert/boligsparingforungdom/2017/08028830701"

<?xml version='1.0' encoding='UTF-8'?>
<boligsparingForUngdom xmlns="no:skatteetaten:datasamarbeid:boligsparingforungdom:v1">
   <personidentifikator>25120800194</personidentifikator>
   <inntektsaar>2015</inntektsaar>
   <aaretsRenter>534.00</aaretsRenter>
</boligsparingForUngdom>

boligsparingForUngdom.xsd

boligsparingForUngdom.xml (eksempel)

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. Dersom feilmeldingen ikke er på dette formatet, kan det være forespørselen ikke har kommet fram til applikasjonen. Se den generelle informasjonen om statuskoder og feilmeldinger.

JSON

{
 "kode": "BSA-003",
 "melding": "Du er ikke autorisert for bruk av dette endepunktet.",
 "korrelasjonsid": "23a235f5-28f9-47db-9abd-ab78977c32fa"
}

XML

Dersom Accept-header er satt til application/xml vil også eventuell feilmelding være i XML:

<feil xmlns="urn:no:skatteetaten:datasamarbeid:feil:v1">
   <kode>BSA-003</kode>
   <melding>Du er ikke autorisert for bruk av dette endepunktet.</melding>
   <korrelasjonsid>a621a996-315d-4b8a-ac6c-6239e67f03e7</korrelasjonsid>
</feil>

feil.xsd

feil.xml (eksempel)

Feilkoder

Se også felles feilkoder for alle applikasjonene.