Hvad er eindoms åbne API?
Med eindoms åbne API kan du koble dine egne systemer sammen med eindom. Du kan hente data ud (fx ejendomme, lejere og opkrævninger) og oprette eller opdatere data automatisk — uden at skulle gøre det manuelt inde i eindom.
Du tilgår API'et med en personlig API-nøgle, som du selv opretter inde i eindom. Hver nøgle giver adgang til ét bestemt selskab.
Bemærk: API'et er et teknisk værktøj, der typisk bruges af en udvikler eller en, der arbejder med integrationer. Du behøver altså ikke bruge det for at få det fulde udbytte af eindom i hverdagen.
Sådan kommer du i gang
Du opretter en API-nøgle under selskabets indstillinger:
Klik på selskabets navn oppe i højre hjørne → vælg Indstillinger → vælg API-nøgler.
Klik på Opret API-nøgle, giv nøglen et sigende navn (fx "Bogføring" eller "Eget dashboard"), og klik Opret.
Nøglen bliver nu vist én gang. Kopiér den med det samme og gem den et sikkert sted — du kan ikke se den igen bagefter.
En API-nøgle starter altid med cak_ og ser fx sådan ud:
cak_a1b2c3d4e5f6g7h8.din-hemmelige-del-her
I oversigten kan du altid se dine nøgler med navn, hvornår de er oprettet, hvem der oprettede dem, og hvornår de sidst er brugt. Hvis en nøgle ikke længere skal bruges — eller hvis du er i tvivl om, at den er kommet i de forkerte hænder — kan du tilbagekalde eller slette den her. Så virker den ikke længere.
Sådan bruger du det
Alle kald sendes til din eindom-adresse efterfulgt af stien til selskabet og dets ID:
https://app.eindom.dk/api/companies/{selskabets-id}/...
For at få adgang skal du sende din API-nøgle med i hvert kald i en såkaldt Authorization-header:
Authorization: Bearer cak_din-nøgle-her
Et eksempel — her henter vi listen over lejere i et selskab:
GET https://app.eindom.dk/api/companies/{selskabets-id}/leases
Authorization: Bearer cak_din-nøgle-her
Godt at vide:
En nøgle giver kun adgang til det ene selskab, den er oprettet under. Prøver du at bruge den på et andet selskab, bliver kaldet afvist.
Nøglen har de samme rettigheder som den bruger, der oprettede den. Kan brugeren ikke se eller ændre noget inde i eindom, kan nøglen det heller ikke.
Svarene kommer i et struktureret format (JSON), som dit system kan læse direkte. Lister kan filtreres og sorteres, og store lister deles op over flere sider.
Hvilke data kan du trække?
API'et dækker stort set alt det, du også kan i eindom. For de fleste områder kan du både hente data, oprette nyt, opdatere og slette. Her er et overblik over, hvad du har adgang til:
Ejendomme & lejemål
Ejendomme og deres lejemål
Lejemålstyper, anvendelse og ejerforhold
Dokumenter og noter på ejendomme og lejemål
Lejere & personer
Lejere (lejeforhold) og de personer, der er tilknyttet
Lejekontrakter (privatkontrakter), opsigelser og fraflytningsopgørelser
Kontoudtog pr. lejer samt invitationer til lejerportalen
Økonomi
Opkrævninger (engangs og finansbilag) samt faste opkrævninger
Indbetalinger og tilbagebetalinger (kreditnotaer)
Opkrævningstyper og betalingsbetingelser
Rykkere & restance
Rykkere og rykkergrupper
Mulighed for at sende rykkere, oprette ophævelser og overføre restance
Regulering, forbrug & dokumenter
Huslejereguleringer (NPI)
Forbrugsregnskaber og forbrugsrapporter
Dokumenter, dokumentskabeloner og digital underskrift
Beskeder til lejere (også samlede udsendelser)
Selskab, brugere & integrationer
Selskabsoplysninger og indstillinger
Brugere og egne metadata-felter
Statistik, dashboard-data og søgning på tværs af selskabet
Bogføringsintegrationer og Betalingsservice-aftaler
Visse områder afhænger af, hvilke funktioner dit selskab har slået til (fx flyttesyn, forsikringer, drift/budget og opslagstavle).
Brug for hjælp?
Sidder du fast, eller er du i tvivl om noget? Skriv til os i chatten — så hjælper vi dig godt videre. 🙌