Hva er eiendoms åpne API?

Med eiendoms open API kan du koble dine egne systemer til eiendom. Du kan hente data (f.eks. eiendomer, leietakere og innkrevinger) og opprette eller oppdatere data automatisk — uten å måtte gjøre det manuelt inne i eiendom.

Du får tilgang til API-et med en personlig API-nøkkel, som du selv oppretter i eiendom. Hver nøkkel gir tilgang til ett spesifikt selskap.

Merk: API-et er et teknisk verktøy som vanligvis brukes av en utvikler eller noen som jobber med integrasjoner. Så du trenger ikke bruke det for å få full nytte av eiendom i hverdagen.

Hvordan komme i gang

Du oppretter en API-nøkkel under selskapets innstillinger:

• Klikk på firmanavnet øverst til høyre → velg Innstillinger → velg API-nøkler.
• Klikk på Opprett API-nøkkel, gi nøkkelen et meningsfullt navn (f.eks. «Bokføring» eller «Eget dashbord»), og klikk på Opprett.
• Nøkkelen vil nå vises én gang. Kopier det umiddelbart og lagre det på et trygt sted — du vil ikke kunne se det igjen etterpå.

En API-nøkkel starter alltid med cak_ og ser slik ut:

cak_a1b2c3d4e5f6g7h8.din-hemmelige-del-her-

I oversikten kan du alltid se nøklene dine etter navn, når de ble laget, hvem som laget dem, og når de sist ble brukt. Hvis en nøkkel ikke lenger trengs — eller hvis du er i tvil om den har havnet i gale hender — kan du trekke tilbake eller slette den her. Så fungerer det ikke lenger.

Hvordan bruke den

Alle samtaler sendes til din eiendom-adresse, etterfulgt av veien til selskapet og dets ID:

https://eiendom.duett.no/api/companies/{company-id}/...

For å få tilgang må du sende API-nøkkelen din i hvert kall i en såkalt autorisasjonsheader:

Autorisasjon: Bærer cak_din-nøkkel-her-her

Et eksempel — her får vi listen over leietakere i et selskap:

HENT https://eiendom.duett.no/api/companies/{selskabets-id}/leasesAuthorization: Bearer cak_din-key-here

Godt å vite:

• En nøkkel gir kun tilgang til det ene selskapet den er opprettet under. Hvis du prøver å bruke det på et annet selskap, vil samtalen bli avvist.
• Nøkkelen har de samme privilegiene som brukeren som opprettet den. Hvis brukeren ikke kan se eller endre noe inne i eiendom, kan heller ikke nøkkelen det.
• Svarene kommer i et strukturert format (JSON) som systemet ditt kan lese direkte. Lister kan filtreres og sorteres, og store lister er delt over flere sider.

Hvilke data kan du hente?

API-et dekker stort sett alt du kan gjøre i eiendom. For de fleste områder kan du hente data, opprette nye data, oppdatere og slette . Her er en oversikt over hva du har tilgang til:

Eiendomer & leie

• Eiendomer og deres leiekontrakter
• Leietyper, bruk og eierskap
• Dokumenter og notater om eiendomer og leiekontrakter

Leietakere & folk

• Leietakere (leieforhold) og personene tilknyttet
• Leiekontrakter (private kontrakter), oppsigelser og utflyttingserklæringer
• Kontoutskrifter per leietaker og invitasjoner til leietakerportalen

Økonomi

• Innkrevinger (engangs- og økonomiske kuponger) samt faste innkrevinger
• Innbetalinger og refusjoner (kredittnoter)
• Gebyrtyper og betalingsvilkår

Påminnelser og restanser

• Påminnelser og påminnelsesgrupper
• Mulighet til å sende påminnelser, opprette kanselleringer og overføre restanser

Regulering, forbruk og dokumenter

• Leiejusteringer (KPI)
• Forbruksregnskaper og bruksrapporter
• Dokumenter, dokumentmaler og digitale signaturer
• Meldinger til leietakere (inkludert aggregerte sendinger)

Selskap, brukere og integrasjoner

• Selskapsinformasjon og anbefalinger
• Brukere og tilpassede metadatafelt
• Statistikk, dashborddata og søk på tvers av selskapet
• Regnskapsintegrasjoner og betalingstjenesteavtaler

Visse områder avhenger av hvilke funksjoner selskapet ditt har aktivert (f.eks. flytteinspeksjon, forsikring, drift/budsjett og oppslagstavle).

Trenger du hjelp?

Sitter du fast eller er du i tvil om noe? Kontakt oss via chatboten — så vil vi hjelpe deg videre. 🙌