Passer au contenu principal

Ce que permet l’API

L’API donne accès aux données de votre conciergerie depuis vos propres outils : un tableur connecté, un script, un outil de suivi. Chaque clé n’ouvre que les données de votre conciergerie, et l’API n’accorde rien que l’application interdit. Aujourd’hui, elle lit : Les factures y sont en lecture seule : générer, envoyer ou prélever une facture reste une action de l’application. La référence de l’API, ci-dessous, liste tout ce qu’elle sert.

Qui peut l’utiliser

L’API est incluse dans les offres Équipe et Agence, et ouverte pendant l’essai gratuit — voir L’abonnement. Avec l’offre Solo, vos clés sont conservées mais ne répondent pas ; elles répondent de nouveau dès que votre conciergerie passe à une offre qui inclut l’API. Les propriétaires de la conciergerie et les administrateurs créent et révoquent les clés.

Créer une clé

1

Ouvrez la section Clés d’API

Dans les paramètres, choisissez Clés d’API, puis « Créer une clé d’API ».
2

Nommez-la et choisissez son expiration

Donnez-lui un nom pour la reconnaître, celui de l’outil qui l’utilisera par exemple, puis son expiration : jamais, dans 30 jours, dans 90 jours ou dans un an.
3

Copiez-la

Choisissez « Créer la clé », puis « Copier la clé ». Elle ne sera plus jamais affichée.
Une clé commence par logeo_sk_. La liste des clés donne pour chacune son nom, son début, sa date de création, son expiration et sa dernière utilisation : une clé jamais utilisée se révoque sans risque. « Révoquer » coupe aussitôt l’accès des outils qui utilisent la clé ; une clé révoquée ne peut pas être rétablie. Cochez plusieurs clés pour les révoquer d’un coup.
Une clé donne accès aux données de votre conciergerie : ne la partagez pas, et révoquez-la dès qu’elle a pu être vue par quelqu’un d’autre.

S’authentifier

Envoyez la clé dans l’en-tête x-api-key de chaque requête, ou dans l’en-tête Authorization, précédée de Bearer.
L’adresse de l’API porte la version de Logeo en cours, à la place de <version>. Chaque réponse la rappelle dans son en-tête Logeo-Api-Version, et une adresse sous une version qui n’est plus servie répond par l’erreur 410, qui indique la version en cours.

Les règles de l’API

La référence de l’API

La référence complète, en anglais, décrit chaque adresse, ses paramètres et ses réponses, et permet d’essayer une requête avec votre clé. Elle est publiée à l’adresse https://logeo.app/api/<version>/docs, et sa description OpenAPI à l’adresse https://logeo.app/api/<version>/openapi.json. Pour interroger vos données en langage courant plutôt que par des requêtes, voir Connecter un assistant IA.

Écrans concernés

Ouvrir les clés d’API

Ouvrir l’abonnement