API und Webhooks
Ihre anderen Tools mit einem API-Schlüssel an die Daten der Agentur anbinden und ihre Ereignisse an Ihrer eigenen Adresse empfangen.
Die Schlüssel werden unter Organisation › API verwaltet, die Empfangsadressen unter Organisation › Webhooks.
Bevor Sie beginnen
- Die Bereiche API und Webhooks erscheinen im Menü nur mit dem Recht „Integrationen“ (standardmäßig nur der Administrator).
- Beide Seiten öffnen sich nur für den Administrator. Ein Manager oder ein Makler, dem das Recht „Integrationen“ gegeben wurde, sieht die Bereiche, wird aber zur Startseite zurückgeleitet.
- Jede Funktion muss in Ihrem Tarif enthalten sein: „API“ für die Schlüssel, „Webhooks“ für die Adressen (siehe Abonnement und Abrechnung). Andernfalls sagt die Seite dies und bietet Tarife ansehen an.
Die API
Die API gibt Zugriff auf die Daten Ihrer Agentur, und nur auf diese.
| Was die API ermöglicht | Erforderlicher Schlüssel |
|---|---|
| Die Kontakte, die beiden Pipelines und ihre Phasen, die Verkaufschancen, die Aufträge, die Anzeigen und die Besichtigungen lesen | Lesen |
| Einen Lead anlegen (Kontakt über seine E-Mail-Adresse wiedergefunden oder angelegt; bei einer Anzeige eine Käufer-Verkaufschance) | Lesen und schreiben |
| Eine Verkaufschance in eine andere Phase ihrer Pipeline verschieben | Lesen und schreiben |
- Die Aufträge werden ohne Verhandlungsspielraum, ohne Provision und ohne Verlauf geliefert.
- Jeder Schlüssel hat Anspruch auf 120 Anfragen pro Minute und 20 000 pro Tag.
Die technische Dokumentation
Die Seite API zeigt die Adresse der API und einen Link Dokumentation an. Dieser Link öffnet die öffentliche technische Dokumentation der API, die für Ihren Entwickler bestimmt ist: jeder Zugang, seine Parameter, seine Antworten, die Art der Authentifizierung mit dem Schlüssel und das seitenweise Durchlaufen der Ergebnisse. In der Produktion befindet sie sich unter der Adresse https://api.immobooking.be/api/v1/externe/docs.
Einen Schlüssel erstellen
- Öffnen Sie Organisation › API.
- Geben Sie auf der Karte Neuer Schlüssel den Namen des Schlüssels ein (2 bis 60 Zeichen), zum Beispiel „Website des Büros“ oder „Dashboard“.
- Kreuzen Sie Darf auch schreiben (Leads anlegen, Chancen verschieben) an, wenn das Tool schreiben soll. Andernfalls kann der Schlüssel nur lesen.
- Klicken Sie auf Schlüssel erstellen.
- Klicken Sie auf der Karte Ihr neuer Schlüssel auf Kopieren und bewahren Sie den Schlüssel dann sicher auf.
- Klicken Sie auf Ich habe den Schlüssel kopiert.
Die Schlüssel verfolgen und widerrufen
Die Liste Ihre Schlüssel zeigt für jeden Schlüssel seinen Namen, seinen Anfang, das Abzeichen „Lesen“ oder „Lesen und schreiben“, sein Erstellungsdatum und seine letzte Verwendung (oder „Nie verwendet“).
- Klicken Sie neben dem Schlüssel auf Widerrufen.
- Bestätigen Sie. Die Meldung „Schlüssel widerrufen.“ erscheint.
Die Tools, die diesen Schlüssel verwenden, verlieren sofort den Zugriff; die anderen Schlüssel funktionieren weiter. Verliert Ihr Tarif die Funktion „API“, werden alle Schlüssel abgelehnt.
Die Webhooks
Ein Webhook sendet bei jedem Ereignis der Agentur eine Nachricht an die Adresse Ihres Tools.
| Ereignis | Wann es gesendet wird |
|---|---|
| „Lead erstellt (neue Chance)“ | eine neue Verkaufschance wird angelegt |
| „Auftrag unterzeichnet“ | ein Auftrag wird unterzeichnet |
| „Anzeige veröffentlicht“ | eine Anzeige wird veröffentlicht |
| „Besichtigung gebucht“ | eine online gebuchte Besichtigung wird bestätigt |
Eine Adresse hinzufügen
- Öffnen Sie Organisation › Webhooks.
- Geben Sie auf der Karte Neue Adresse die Adresse (https) Ihres Tools ein.
- Kreuzen Sie mindestens eines der Ereignisse an.
- Klicken Sie auf Adresse speichern.
- Klicken Sie auf der Karte Signaturgeheimnis auf Kopieren und übergeben Sie das Geheimnis Ihrem Entwickler.
- Klicken Sie auf Ich habe das Geheimnis kopiert.
- Das Geheimnis wird nur einmal angezeigt. Ihr Tool verwendet es, um zu prüfen, dass die Nachrichten wirklich von ImmoBooking stammen; die Karte Eine Nachricht prüfen erklärt, wie.
- Höchstens zehn Adressen.
- Mögliche Ablehnungen: „Diese Adresse ist ungültig.“, „Die Adresse muss mit https:// beginnen.“, „Diese Adresse verweist auf ein internes Netzwerk: Sie wird abgelehnt.“.
Eine Adresse verwalten
Unter Ihre Adressen trägt jede Adresse das Abzeichen „Aktiv“ oder „Pausiert“.
- Test senden: Eine Testnachricht wird innerhalb einer Minute gesendet.
- Pausieren und Fortsetzen.
- Löschen: Es wird keine Nachricht mehr dorthin gesendet, und der Verlauf ihrer Zustellungen wird gelöscht.
Die Zustellungen verfolgen
Unter Letzte Zustellungen trägt jede Nachricht den Status „Ausstehend“, „Zugestellt“ oder „Fehlgeschlagen“, die Zahl der Versuche und gegebenenfalls die Uhrzeit des nächsten Versuchs.
- Ihr Tool muss innerhalb von 10 Sekunden mit einer Erfolgsantwort antworten. Einer Weiterleitung wird nicht gefolgt, sie zählt als Fehlschlag.
- Bei einem Fehlschlag wird die Nachricht 1, 5 und 30 Minuten später erneut gesendet, dann nach 2, 6, 12 und 24 Stunden, also während fast zwei Tagen.
- Nach dem letzten Versuch ist der Fehlschlag endgültig. Erneut senden reiht die Nachricht wieder ein („Zustellung wieder eingereiht.“).