API – Introduktion

Bookhus API gør det muligt at hente data fra Bookhus til brug i egne websites, portaler og integrationer. I kan blandt andet hente huslister, husbeskrivelser, billeder, kalenderdata, filtrerede søgeresultater, bookingmuligheder og prislister.

Bookhus apibeskriveslse

Kom godt i gang

For at komme i gang med Bookhus API skal der i nogle tilfælde oprettes en API-nøgle i Bookhus administrationen under modulet API Keys. API-nøglen bruges derefter i de kald, hvor der kræves adgangsgodkendelse.

Nogle endpoints er offentligt tilgængelige og kan bruges uden login eller API-nøgle. Andre endpoints kan kræve login eller en gyldig API-nøgle, afhængigt af hvordan jeres Bookhus-løsning er sat op.

Hvis du er i tvivl om, hvilke endpoints der kræver adgang, fremgår det af beskrivelsen på det enkelte endpoint.

Formater

De fleste API’er understøtter både JSON og XML som responsformat.

Bookhus apibeskriveslse

Vigtige ting at vide

• Brug altid jeres eget Bookhus-domæne som base.

• Datoer sendes typisk som YYYY-MM-DD.

• Nogle endpoints returnerer JSON, nogle returnerer XML, og nogle returnerer HTML eller binært indhold, afhængigt af endpointet.

  Bookhus apibeskriveslse

• For kalenderdata kan brugere, administratorer og tilsynsførende med de rette rettigheder se mere information end anonyme brugere.

  Bookhus apibeskriveslse

• 
  

Typisk arbejdsgang

En typisk integration vil ofte se sådan ud:

1. Hent en liste over huse

2. Hent beskrivelse for et valgt hus

3. Hent billede til huset

4. Hent kalender eller bookingmuligheder

5. Vis prisliste

Oversigt over endpoints

• GET /api/overview/houselist

• GET /api/overview/housedescription

• GET /houseimage/{imageId}/{maxWidth}/{maxHeight}

• GET /siteimage/{imageId}/{maxWidth}/{maxHeight}

• GET /api/calendar

• GET /api/getCatalogEmneList

• GET /api/booking/getbookingposibilities

• GET /PriceList/PartialPriceList/{houseId}

  Bookhus apibeskriveslse