Bienvenue sur l'API publique Stonal
À quoi sert l'API Stonal ?
L'API vous permet de connecter Stonal à votre système d'information et d'automatiser les échanges de données dans les deux sens :
- 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 |
|---|---|---|
| Objets (Assets) | Importer, synchroniser et relier vos objets (bâtiments, lots, équipements), gérer leur hiérarchie et rechercher dans votre patrimoine. | Guide |
| Documents | Déposer des documents, laisser l'IA les classer et en extraire les informations clés, puis les rechercher et les relier à vos objets. | Guide |
| Utilisateurs (Users) | Provisionner les utilisateurs et gérer leurs droits d'accès : quels objets, quelles applications et quels rapports chacun peut consulter. | Guide |
| Contrats (Contracts) | Créer et tenir à jour des contrats (baux, contrats de maintenance…) reliés à des objets, des équipements et des intervenants. | Guide |
| Intervenants (Stakeholders) | Gérer les contacts — personnes physiques ou sociétés — liés à vos contrats. | 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 caractéristiques (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 Objets (Assets)
2. Centraliser et exploiter vos documents
Déposer en masse vos documents (baux, diagnostics, factures, comptes rendus d'AG…) et laisser l'IA de Stonal faire le travail de classement : elle catégorise chaque fichier, en extrait les informations clés (dates, montants, adresses, identifiants d'objets…) et le rattache automatiquement aux objets concernés.
Vous récupérez ensuite ces documents et leurs métadonnées par recherche, directement dans vos outils. Par exemple, un lot de factures déposé en fin de mois est trié, indexé et relié aux bons bâtiments sans classement manuel.
→ API Documents
3. Piloter vos contrats et vos intervenants
Créer des contrats (baux, contrats de maintenance, prestations…) et les relier à tout ce qui les concerne : les objets et équipements couverts, ainsi que les intervenants — 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'ascenseur peut être rattaché à l'équipement concerné et à son prestataire, ce qui donne une vue consolidée de qui intervient, sur quoi et jusqu'à quand.
→ API Contrats (Contracts) et Intervenants (Stakeholders)
4. Gérer les accès de vos utilisateurs
Provisionner automatiquement vos utilisateurs et leurs droits d'accès depuis votre annuaire d'entreprise, puis les garder synchronisés. Les droits peuvent être attribués via des groupes (un ensemble de permissions appliqué à plusieurs personnes à la fois) ou individuellement, pour contrôler finement qui accède à quels objets, quelles applications et quels rapports.
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)
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 ?
- Obtenir un compte Stonal — contactez le support API (par e-mail ou via Slack).
- Créer des identifiants — définissez un utilisateur API et générez un jeton d'accès personnel (PAT).
- 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 et la création de vos accès.