Kobo Bolig API Maskinporten
Kobo Bolig API kan kun konsumeres når man har et gyldig Maskinporten token.
Overordnet
Etter at leverandøren har registrert en klient for Maskinporten i Maskinporten Onboarding, må implementasjonen til leverandøren kalle Maskinporten og be om token.
Husbanken Kobo Bolig API Scope
I Maskinporten har Husbanken et Maskinporten Scope som har det tekniske navnet "husbanken:kobo/boligapi.write", dette er et Private Scope i Maskinporten og kan kun benyttes etter at Husbanken har tildelet det til kommunen og dens leverandør.
For at kommunens system skal kunne benytte scopet i Maskinporten må Husbanken tildele scopet til både kommunen og til leverandøren kommunen ønsker å delegere scopet til.
Testmiljø
Testmiljøet bruker utelukkende syntetiske data fra Tenor for personer, kommuner og virksomheter.
Det er viktig å merke seg at testdata i Tenor er "levende" og kan endre seg, så hvis feks personen som rår over virksomheten eller kommunen ikke lengre har tilgang til å administrere virksomheten i Altinn test bør man sjekke i Tenor om personen fortsatt er daglig leder feks, eller om virksomheten er avviklet.
Nødvendig informasjon for oppsett
For å kunne teste trenger man å velge seg ut følgende data og dele med Husbanken.
- En syntetisk kommune
- En syntetisk person som har tilgang til å forvalte en kommune i Altinn
- En syntetisk virksomhet som kan være leverandør for kommunen
- En suntetisk person som har tilgang til å forvalte virksomheten
Se kapittelet for Tenor for hvordan man kan finne frem til gyldige syntetiske data.
Produksjon
For nye kommuner som ikke har tatt i bruk Kobo bør de starte med informasjonen på siden Kom i gang med Kobo, så i tillegg må Husbanken motta informasjonen som registreres i skjema Kobo integrasjonsskjema
Prosess for tilkobling
Dette er overordnet prosessen for å komme i gang med Kobo Bolig API
- Velge testdata fra Tenor for syntetisk kommune og virksomhet for integrasjonspartner.
- Send inn registreringsskjema til Kobo for testdata og informasjon om integrasjonspartner for testmiljø
- Husbanken registrer og tildere den syntetiske kommunen og virksomheten tilgang til Husbankens Kobo BoligAPI scope.
- Virksomheten konfigurerer den syntetiske kommunen
- Utvikling av virksomhetens integrasjon kan begynne
- Før produksjonssetting vil Husbanken, virksomheten og kommunen gjøre en integrasjonstest sammen før aktivering av integrasjonen i produksjon
- Virksomheten oversender integrasjonsskjema for detaljer om produksjon
Disse data kan man finne frem til i Tenor for virksomheter
Tenor Testdata Norge - syntetiske data
Følgende beskrivelse kan følges for å velge ut syntetiske data fra Tenor
- Velg syntetisk kommune med daglig leder, se syntetisk kommune
- Velg syntetisk virksomhet med daglig leder, se syntetisk virksomhet
- Logg inn i Altinn test daglig leder for kommunen slik at det blir opprettet en profil der
- Logg inn i Altinn test daglig leder for virksomheten slik at det blir opprettet en profil der
- Meld inn skjema med valgt kommune og virksomhet Husbanken skal delegere scope til, send inn integrasjonsskjema for test
- Som daglig leder for kommunen logget inn i Altinn test, deleger maskin API for Kobo til virksomheten
- Som daglig leder for virksomheten logget inn i Maskinporten Onboarding sett opp en klient for tildelt rettighet
Man kan da konsumere Kobo Bolig API når Husbanken melder tilbake at Husbanken har tildelt tilgangen til "husbanken: kobo/boligapi.write" til både kommunen og virksomheten.
Syntetisk kommune
Søk frem en kommune i Tenor testdatasøk hos Skatteetaten.
Noter ned hvem som er "Daglig leder/administrerende direktør".
Feks for "Rosa Modig Bjørn Kommune" (orgnr: 310150924) er det fødselsnummer "19818899419".
Når man har valgt seg en kommune må orgnummer og fødselsnummer deles med Husbanken slik at de kan konfigureres i Kobo.
Syntetisk virksomhet
Søk frem en virksomhet i Tenor testdatasøk hos Skatteetaten.
Feks for "Operativ Sammarbeidsvillig Tiger AS" (orgnr: 313116360) er det fødselsnummer "21876199545".
Når man har valgt seg en virksomhet må orgnummer og fødselsnummer deles med Husbanken slik at de kan konfigureres i Kobo.
Kobo Integrasjonsskjema
Integrasjonsskjema for test
Denne tabellen gjelder for oppsett i test. Der er ytterlige informasjon Husbanken trenger for oppsett av en kommune i produksjon, denne informasjonen er tilgjengelig for kommunen i øvrig introduksjonsmateriale for kommunen.
| Info | Beskrivelse | Eksempel |
|---|---|---|
| Kommune organisasjonsnummer* | Organisasjonsnummeret for behandlingsansvarlig kommune | 310150924 Rosa Modig Bjørn Kommune |
| Kommunedirektør fnr* | Personnummeret til daglig leder for kommunen som kan delegere Kobo Bolig API til leverandøren | 19818899419 |
| Leverandør endepunkt | Endepunktet Kobo kan kalle når det er hendelser som er relevante for leverandøren | https://fdvu-system.net/kobo-hook/ |
| Leverandør system-id | Unik systemid som et fasttekst felt valgt av kommunen eller leverandøren for det gitte systemet som integrerer | fdvu-system-01 |
| Leverandør organisasjonsnummer** | Leverandørens organisasjonsnummer | 313116360 Operativ Sammarbeidsvillig Tiger AS |
| Leverandør daglig leder fnr** | Ikke nødvendig å dele med Husbanken, men praktisk å ha tilgjengelig hvis Husbanken skal bistå med feilsøking i testmiljøet |
Integrasjonsskjema for produksjon
| Info | Beskrivelse |
|---|---|
| Kommune organisasjonsnummer | Organisasjonsnummeret for behandlingsansvarlig kommune |
| Leverandør endepunkt | Endepunktet Kobo kan kalle når det er hendelser som er relevante for leverandøren |
| Leverandør system-id | Unik systemid som et fasttekst felt valgt av kommunen eller leverandøren for det gitte systemet som integrerer |
| Leverandør organisasjonsnummer | Leverandørens organisasjonsnummer |