Doel
Het tabblad “API en webhooks” stelt beheerders in staat om externe tools via de REST API leestoegang te geven tot de organisatiegegevens, en ondertekende meldingen te ontvangen wanneer bepaalde gegevens wijzigen.
De beschikbare resources zijn gebouwen, eenheden, huurovereenkomsten, eigenaren, advertenties en transacties, terwijl de webhooks de aanmaak en wijziging van een huurovereenkomst, de ontvangst van een betaling en de binnenkomst van een nieuwe aanvraag dekken.
Waar te vinden
- Vermogen
- Rapporten
Tabblad “API en webhooks”, voorbehouden voor beheerders.
Stappen
- Voer een “Naam van de sleutel” in de kaart “API-sleutels” in en klik op “Sleutel aanmaken”.
- Kopieer de sleutel onmiddellijk met “Kopiëren”, aangezien deze niet opnieuw wordt weergegeven, en geef deze vervolgens door in de Authorization-header van uw oproepen.
- Voer in de kaart “Webhooks” het “HTTPS-adres” in, vink de gewenste “Gebeurtenissen” aan en klik op “Webhook toevoegen”.
- Kopieer het weergegeven ondertekeningsgeheim, waarmee uw server de herkomst van elke verzending kan verifiëren.
- Klik op “Test versturen” om de ontvangst te controleren en raadpleeg vervolgens de “Recente verzendingen”.
Goed om te weten
- De API is beperkt tot 120 verzoeken per minuut en per sleutel, waarbij de documentatie van het tabblad de paginering en de filter op wijzigingsdatum beschrijft.
- Een ander antwoord dan 2xx leidt tot maximaal drie nieuwe verzendingen van de webhook.
- “Intrekken” verbreekt onmiddellijk de toegang van toepassingen die een sleutel gebruiken, en “Opschorten” onderbreekt een webhook zonder deze te verwijderen.