Récupérer un document

Webhook

IntentPlatform met à disposition un mécanisme de webhook (à destination des services d'information des tiers) permettant d'être notifié dès qu'un nouveau document est disponible.

Solution technique

Au sein du message reçu sur votre url, vous retrouvez certaines informations sur le document. A l'aide du lien HAL urlApi , vous pouvez directement réaliser un appel API GET /documents/{id} pour récupérer toutes les données caractérisant le document.

Dans le JSON, vous trouverez l'ensemble des informations du document.
Vous pourrez directement télécharger le document en réalisant un GET sur l'url indiquer dans la rubrique "_links/download".

Une fois le wehbook reçu, lancement des actions suivantes :
  • Appel API sur le champ urlApi : GET /documents/{id}
  • Récupération des informations du document
  • Appel API pour télécharger le document

Polling

Solution technique

API documents v1
Méthode : GET
Paramètres : since={date}
/api/documents/v1/documents?since=2023-10-08T10:00:00

Le paramètre since vous permet de récupérer tous les nouveaux documents et les documents ayant eu des mises à jour depuis la date indiquée dans le paramètre since.
L'API Documents v1 est paginée, c'est à dire que vous ne pouvez pas récupérer plus de 100 documents par page, il faudra donc utiliser la pagination comme indiqué ici  Gestion de la pagination des API  s 

Dans le JSON, vous trouverez l'ensemble des informations du document.
Vous pourrez directement télécharger le document en réalisant un GET sur l'url indiquer dans la rubrique "_links/download".