Introductie

Wilt u gegevens exporteren voor bijvoorbeeld uw website? Door middel van onze API kan er een koppeling gerealiseerd worden en kunt u uw woning gegevens uitwisselen met andere systemen. Hierbij kan je denken aan het ophalen van specifieke woningen of een complete uitdraai van alle woningen bij een makelaar.

Inschakelen van de API

De API kan ingesteld worden door in het menu te gaan naar “Instellingen” en vervolgens tussen de api koppelingen te gaan zoeken naar “Keysoftware Api”. Het is mogelijk om meerdere api keys vrij te geven voor verschillende partijen. 

 

Om een partij toe te voegen om die de API kan gebruiken. Volgt u de volgende stappen.

1. Klik op de groene knop naast “Aangemaakt op”.
2. Vervolgens opent er een popup waar je de naam van de partij invoert.
3. Klik vervolgens op toevoegen.
4. Vervolgens zie je de partij in het tabel staan.
5. Klik vervolgens op de oranje knop, nu worden de gegevens voor die partij opgehaald. Dat ziet er als volgt uit:

1. Welkom bij de keysoftware api! Gebruik de volgende informatie om een koppeling te bouwen tussen jouw systeem en Keysoftware! 
   U kunt de api documentatie & spelregels vinden op https://api.keysoftware.nl/ 
   
   Naam: Keysoftware
   Public key: {Verborgen}
   Private key: {Verborgen}
   
   Sla deze gegevens op een veilige plek op!

1. Stuur deze gegevens vervolgens naar de partij die een koppeling wilt maken.

De API is bereikbaar op: https://mijn.keysoftware.nl/api/v1

API limieten & foutafhandeling

Per onderwerp gelden aparte api call limieten door de grootte van de data dat geëxporteerd wordt.

Per onderwerp is er een lijst met specifieke foutcodes en uitleg, dit omdat het dat je dan zo makkelijk mogelijk wordt gemaakt.