Documents

Le présent document explique les scénarios de raccordement aux APIs d’intentPlatform sur le périmètre des documents.

Avant de se lancer

Pour bien comprendre et utiliser ce document, il est important d’avoir compris le fonctionnement des API d’intentPlatform. L’utilisation de ce document intervient une fois avoir lu et compris la  documentation en ligne .

Pour vous acculturer avec les APIs d’intentPlatform :  Introduction à l’API 
  • Focus sur les  documents 

Sommaire des scénarios

Bonnes pratiques

Patrimoine

Je dois être en capacité de gérer une correspondance des références patrimoine de mon client. Les gestionnaires immobiliers maîtrisent de plus en plus leur propre référentiel de patrimoine (bâtiments, équipements). Le gestionnaire immobilier attend que vos données soient publiées sur son référentiel de patrimoine portant ses références.

Méthodes pour transmettre des documents

Upload de documents

intentPlatform vous propose 2 méthodes pour automatiser la transmission (upload) de vos documents sur la plateforme :
  •  API 
  •  FTP 
Il vous est également possible d’importer manuellement vos documents directement depuis les interfaces web et mobile d’intentPlatform.

En-tête requête HTTP

La transmission des fichiers via l’API Documents se réalise en utilisant, dans le Header de la requête, un "Content-Type: multipart/form-data"

Association d’un document à une ressource

En fonction de vos scénarios, votre document sera rattaché à 3 types de ressources. 
Title
Title

Ressource

Exemples de document

Patrimoine (asset)
Règlement intérieur, guide d’utilisation d’un équipement, doc technique d’un équipement, diagnostic amiante …
Operations (intervention, quotation, reservation)
Quitus d’intervention, devis, CR d’intervention …
Contrat (contract)
Version électronique du contrat, CCTP, avenants …
Un document peut-être attaché à une unique ressource. Si un document venait à concerner plusieurs ressources, par exemple plusieurs bâtiments, il devra être dupliqué sur chaque bâtiment.
Par exemple, si vous réalisez le diagnostic immobilier du bâtiment A et B et que toutes les informations sont dans un unique document, il faudra le publier 2 fois. Une fois sur le bâtiment A et une autre fois sur le bâtiment B.

Lien de consultation d'un document

intentPlatform vous permet de mettre à disposition vos documents par l'intermédiaire d'un lien de consultation. Vous êtes responsable de l'hébergement du document et de son accès. Ce fonctionnement est possible pour les documents en lien avec des opérations (intervention, devis et réserve).