Kobo Bolig Webhook API

Kobo Bolig Webhook API er et API som skal tilgjengeliggjøres på den internettadressen FDVU leverandøren har meldt inn til Husbanken som integrasjonspunkt. API'et skal kun være tilgjengelig på HTTPS og svare på alle kall.

Kallet

Kobo utfører et HTTP Post kall til FDVU leverandøren når det skjer noe i tilknytning til boligen som er relevant for FDVU systemet å vite.

Dette kan være

• Status endring
• Redigering av boligens egenskaper

Statusendringer gjelder når boligen feks blir reservert, utleid, solgt osv.

Under er et utdrag fra OpenAPI spesifikasjonen av kallet.

paths:
    /kobo-hook/:
        post:
            tags:
                - kobo-hook
            summary: Motta en melding fra Kobo
            operationId: mottaKoboWebHook
            requestBody:
            content:
                application/json:
                    schema:
                        $ref: "#/components/schemas/MeldingTO"
                    responses:
                        '204':
                        description: Meldingen ble mottatt vellykket

Objektet som oversendes fra Kobo har følgende felter:

MeldingTO

Feltnavn	Datatype	Obligatorisk	Merknader
apiKey	string	ja	Sikkerhetsnøkkel, se eget avsnitt om Sikkerhet
behandlingsansvarligOrgNr	string	ja	Organisasjonsnummeret som FDVU leverandøren representerer
koboboligid	uuid	ja	Unik nøkkel til boligen i Kobo
boligstatus	enum	ja	Siste gjeldende status i Kobo for boligen
statusdato	dato	nei	Geldende dato for statusen i kobo
hint	enum	ja	Hvilken hendelse i Kobo som har utløst Kobo Webhook meldingen

Sikkerhet

I Bolig API er der en operasjon for å registrere apiKey. Det er en hemmelighet som FDVU leverandøren bestemmer og registrerer i Kobo.

Før denne er registrert ved et maskin til maskin kall til Kobo vil ikke Kobo gjøre forsøk på å kontakte FDVU systemet.

Når en slik nøkkel er registrert vil Kobo ved gitte hendelser kalle FDVU leverandøren med nøkkelen til boligen, og FDVU systemet skal da verifisere at apiKey stemmer med det Kobo har fått oppgitt av FDVU systemet.

Hvis dette ikke stemmer over ens skal meldingen avvises med 401 HTTP statuskode.

Bolighendelser

Følgende bolighendelser i Kobo kan utløse et Webhook kall til FDVU leverandøren.

Hendelse	Enum	Beskrivelse
Opprettet bolig	BOLIG_OPPRETTET	*Denne er foreløpig ikke støttet
Bolig endret	BOLIG_ENDRING	Egenskaper ved boligen er redigert i Kobo.
Bolig status	BOLIG_STATUS	Boligen har fått endret status i Kobo, se boligstatuser.