Skip to main content
Firby expose une API REST : tout ce que vous voyez dans l’application (factures, logements, propriétaires, réservations, dépenses exceptionnelles) est interrogeable depuis vos propres outils — un tableur connecté, un script, votre outil de reporting.

​
Créer une clé API

  1. Ouvrez Réglages → API (page Clés API).
  2. Cliquez sur Nouvelle clé et nommez-la pour la reconnaître (ex. « Intégration compta »).
  3. Copiez la clé immédiatement : pour des raisons de sécurité, elle ne sera plus jamais affichée.
Les clés commencent par firby_sk_. Le tableau des clés affiche leur date de création, leur expiration éventuelle et leur dernier usage ; Révoquer coupe immédiatement les intégrations qui utilisent la clé.
La gestion des clés est réservée aux rôles propriétaire et administrateur de la conciergerie. Chaque clé ne donne accès qu’aux données de votre conciergerie.

​
S’authentifier

Envoyez la clé dans l’en-tête x-api-key de chaque requête (l’en-tête Authorization: Bearer est aussi accepté) :
Chaque clé est limitée à 120 requêtes par minute.

​
Ce que l’API permet

Les logements et propriétaires exposent aussi leur identifiant côté PMS (pmsListingId, pmsOwnerRef) : pratique pour croiser les données Firby avec celles de votre PMS. Les listes sont paginées avec limit (100 par défaut, 500 maximum) et offset.

​
La documentation interactive

La référence complète — chaque endpoint, ses paramètres et un mode « essayer » où vous collez votre clé — est intégrée à l’application sur /docs. La spécification OpenAPI est disponible sur /api/v1/openapi.json.
Vous préférez poser vos questions en français plutôt qu’en HTTP ? Connectez Claude ou ChatGPT à votre espace Firby : voir Connecter un assistant IA.