Clés API

Vue d'ensemble

Le module de clés API offre aux utilisateurs de VillaTax un moyen contrôlé d'accéder à la surface API publique exposée par le produit. Il est intentionnellement pratique : créer une clé, l'utiliser pour authentifier les requêtes API, la révoquer lorsqu'elle n'est plus nécessaire.

Le module se trouve à Clés API. La spécification API est disponible à documentation API.

Ce que le module supporte

• Créer une nouvelle clé : générer une clé d'accès liée au compte authentifié
• Voir les clés existantes : voir quelles clés sont actives et la date de dernière utilisation
• Révoquer une clé : désactiver définitivement une clé lorsqu'une intégration est décommissionnée

Périmètre et propriété de l'API

L'API publique VillaTax est scopée par utilisateur. Une seule clé API accorde l'accès à toutes les organisations appartenant à l'utilisateur authentifié. L'organisation peut être ciblée comme paramètre de filtre sur les requêtes individuelles, mais une clé couvre l'intégralité du compte.

Pourquoi l'accès API est important

• Automatisation des rapports : extraire les données dans un outil de reporting externe sans exports manuels
• Systèmes comptables externes : pousser les enregistrements VillaTax dans un produit comptable tiers
• Tableaux de bord personnalisés : combiner les données VillaTax avec d'autres sources opérationnelles
• Intégration avec les systèmes de gestion : connecter VillaTax à un workflow de gestion immobilière plus large

Hygiène de sécurité

• Les clés ne sont affichées qu'au moment de la création. Après cela, seules les métadonnées sont visibles.
• Si une clé est compromise, elle peut être révoquée immédiatement sans affecter la connexion au compte.
• Créer une clé séparée par contexte d'intégration est une bonne pratique.

Pour commencer

Ouvrez Clés API lorsqu'une intégration nécessite un accès programmatique. Créez une clé, copiez-la au moment de la création, et configurez-la dans le système externe. Révoquez la clé depuis la même page lorsque l'intégration n'est plus active. Consultez documentation API pour la liste des endpoints disponibles.