But
L’onglet « API et webhooks » permet aux administrateurs de donner à des outils tiers un accès en lecture aux données de l’organisation par l’API REST, et de recevoir des notifications signées lorsque certaines données changent.
Les ressources disponibles sont les immeubles, les unités, les baux, les propriétaires, les annonces et les transactions ; les webhooks couvrent la création et la modification d’un bail, la réception d’un paiement et l’arrivée d’une nouvelle demande.
Où la trouver
- Patrimoine
- Rapports
Onglet « API et webhooks », réservé aux administrateurs.
Étapes
- Saisissez un « Nom de la clé » dans la carte « Clés d’API » et cliquez sur « Créer une clé ».
- Copiez la clé immédiatement avec « Copier », car elle ne sera plus affichée, puis transmettez-la dans l’en-tête Authorization de vos appels.
- Dans la carte « Webhooks », saisissez l’« Adresse HTTPS », cochez les « Événements » souhaités et cliquez sur « Ajouter un webhook ».
- Copiez le secret de signature affiché, qui permet à votre serveur de vérifier l’origine de chaque envoi.
- Cliquez sur « Envoyer un test » pour contrôler la réception, puis consultez les « Derniers envois ».
Bon à savoir
- L’API est limitée à 120 requêtes par minute et par clé ; la documentation de l’onglet décrit la pagination et le filtre par date de modification.
- Une réponse autre que 2xx entraîne jusqu’à trois nouveaux envois du webhook.
- « Révoquer » coupe immédiatement l’accès des applications qui utilisent une clé, et « Suspendre » interrompt un webhook sans le supprimer.