Bienvenue sur l'API Stonal
À quoi sert l'API Stonal ?
Branchez Stonal sur vos outils pour que vos données patrimoniales restent à jour sans ressaisie : vos bâtiments, vos documents et vos contrats se synchronisent automatiquement, dans les deux sens.
Concrètement, l'API vous permet de :
- alimenter Stonal depuis vos outils (ERP, logiciel de gestion, annuaire d'entreprise…) ;
- récupérer dans vos outils les données enrichies par Stonal (documents classés, informations extraites…) ;
- être notifié automatiquement dès qu'une donnée évolue.
Dans Stonal, un objet (asset) désigne un élément de votre patrimoine : un bâtiment, un lot, un équipement… C'est le terme employé dans les interfaces Stonal (par exemple « sélectionner un objet » dans le générateur de requêtes). Pour faciliter le passage à la documentation technique, le terme anglais d'origine est rappelé entre parenthèses tout au long de cette page.
Les API disponibles
| API | À quoi elle sert | En savoir plus |
|---|---|---|
| Patrimoine (Assets) | Importer, synchroniser et relier vos objets (bâtiments, lots, équipements), gérer leur hiérarchie et rechercher dans votre patrimoine. | Guide |
| Utilisateurs (Users) | Provisionner les utilisateurs et gérer leurs droits d'accès : quel patrimoine, quelles applications et quels rapports chacun peut consulter. | Guide |
| Documents | Déposer en masse vos documents (diagnostics, consuel, acte de vente, baux, attestation d'assurance locataire…) et laisser l'IA de Stonal les classer, en extraire les informations clés et les rattacher automatiquement à votre patrimoine. | Guide |
| Contacts (Stakeholders) | Ajouter et tenir à jour des contacts dans la plateforme Stonal (gardiens d'immeuble, exploitants de maintenance…). | Guide |
| Contrats (Contracts) | Ajouter et tenir à jour des contrats (baux, contrats de maintenance…) en précisant le périmètre d'intervention, l'éventuel type d'équipement concerné et le contact lié. | Guide |
| Webhooks | Être notifié en temps réel des changements (création, modification, suppression de documents). | Guide |
Exemples de cas d'usage
Voici quelques scénarios concrets. Ils sont souvent combinés au sein d'un même projet d'intégration.
1. Synchroniser automatiquement votre patrimoine
Maintenir dans Stonal un référentiel à jour de vos objets (bâtiments, lots, équipements) en les important et en les synchronisant depuis votre SI (ERP, outil de gestion), plutôt que par double saisie manuelle. À chaque évolution côté SI, les objets et leurs propriétés (surface, adresse, identifiants internes…) sont mis à jour dans Stonal, ce qui garantit une source unique et fiable.
Vous pouvez aussi créer des liens entre objets pour reconstituer leur hiérarchie : un équipement rattaché à un lot, lui-même rattaché à un bâtiment. Par exemple, lors de l'entrée d'un nouveau bâtiment dans votre parc, votre SI déclenche sa création dans Stonal avec toute son arborescence, sans intervention manuelle.
→ API Patrimoine (Assets)
2. Gérer les accès de vos utilisateurs
Provisionner automatiquement vos utilisateurs depuis votre annuaire d'entreprise, puis les garder synchronisés. Pour chaque utilisateur, définissez ce à quoi il a accès : le patrimoine concerné, les fonctionnalités autorisées et les applications ouvertes. Pour gagner du temps, regroupez les utilisateurs qui ont les mêmes droits dans des groupes.
Par exemple, à l'arrivée d'un collaborateur, son compte et ses accès sont créés automatiquement ; à son départ, ils sont révoqués — sans démarche manuelle et sans risque d'oubli.
→ API Utilisateurs (Users)
3. Centraliser et exploiter vos documents
Déposer en masse vos documents (diagnostics, consuel, acte de vente, baux, attestation d'assurance locataire…) et laisser l'IA de Stonal faire le travail de classement : elle catégorise chaque fichier pour le ranger automatiquement dans le bon dossier, en extrait les informations clés (dates, informations clés des diagnostics, acquéreur…) et le rattache automatiquement aux objets concernés (par exemple, un diagnostic de lot est rattaché au lot correspondant). Vous pouvez aussi préciser dès l'import le type de document (sa classe), le dossier dans lequel le ranger et l'éventuel lot ou bâtiment auquel il fait référence : si vous connaissez déjà l'information, nous vous recommandons de la renseigner.
Vous récupérez ensuite ces documents et leurs métadonnées par recherche, directement dans vos outils. Par exemple, un DAPP est catégorisé comme tel, rangé dans le bon dossier de l'arborescence documentaire et relié au bon bâtiment.
→ API Documents
4. Renseigner vos contacts et contrats
Créer des contrats (baux, contrats de maintenance, prestations…) et les relier à tout ce qui les concerne : le périmètre d'intervention (les bâtiments couverts), le type d'équipement concerné (ex. les ascenseurs — on en déduit ensuite les équipements précis via le périmètre + le type), ainsi que les contacts — locataires, propriétaires ou prestataires, qu'il s'agisse de personnes physiques ou de sociétés. Vous maintenez ensuite ces contrats à jour tout au long de leur cycle de vie (renouvellement, avenant, résiliation).
Par exemple, un contrat de maintenance d'ascenseurs porte sur un périmètre de plusieurs bâtiments et sur le type d'équipement « ascenseur » ; il est relié à son prestataire, ce qui donne une vue consolidée de qui intervient, sur quel périmètre et jusqu'à quand.
→ API Contacts (Stakeholders) et Contrats (Contracts)
5. Réagir en temps réel aux changements
Plutôt que d'interroger l'API en permanence pour repérer les nouveautés, laissez Stonal vous prévenir : à chaque fois qu'un document est créé, modifié ou supprimé dans votre organisation — y compris lors des traitements automatiques (OCR, classification IA…) — un webhook appelle votre système avec le détail de l'événement.
Vous pouvez ainsi déclencher une action de votre côté en temps réel. Par exemple, dès qu'un nouveau bail est classé par l'IA, votre outil métier est notifié et peut lancer le workflow de validation correspondant.
→ Webhooks
Comment démarrer ?
- Créer vos identifiants — créez un utilisateur API et générez un jeton d'accès personnel (PAT). Pas encore de compte ? Rapprochez-vous d'un administrateur de votre organisation ou de votre responsable de compte Stonal, c'est nécessaire à la création des identifiants API.
- Choisir votre cas d'usage — identifiez l'API correspondante dans le tableau ci-dessus, puis transmettez le guide technique associé à votre DSI.
Le support Stonal peut vous accompagner dans le cadrage de votre projet d'intégration.