Aller au contenu principal

Comment effectuer une synchronisation de nuit

Problème / Solution

Problème : Les webhooks mettent à jour votre système mais vous devez être absolument certain que tous vos documents sont correctement synchronisés.

Solution : Une requête de documents que vous pouvez exécuter chaque nuit et qui renvoie tout ce qui s’est passé depuis la nuit précédente.

Comment faire

Ajoutez simplement 'modified_gt=' à la requête /api/v1/document.

Par ex. Obtenez jusqu’à 500 documents modifiés depuis une date et heure précédentes (sans les détails des signataires).

/api/v1/document/?group=your-group&nosigners=1&limit=500&modified_gt=[datetime of last query]

/api/v1/document/?group=your-group&nosigners=1&limit=500&offset=500&modified_gt=[datetime of last query]

astuce

Cette requête inclut le paramètre nosigners=1. Si vous n’avez pas besoin des informations sur le statut des signataires (vous pouvez ne nécessiter que le statut du document) cela rendra votre requête beaucoup plus rapide. Accélérez encore plus en utilisant une valeur élevée de limit. (Aller à la référence du statut de document).

Le paramètre offset itère la liste. Itérez facilement vos documents en récupérant l’URL suivante à interroger dans l’élément 'next' de l’objet 'meta' d’une réponse. Quand la valeur next est nulle il n’y a plus d’éléments à obtenir.

Exemple de réponse incluant 'meta' :

{
"meta": {
"limit": 20,
"next": "/api/v1/document/?limit=20&offset=40&group=xxxx",
"offset": 20,
"previous": "/api/v1/document/?limit=20&offset=0&group=xxxx",
"total_count": 192
},
"objects": [
{
"archived": false,

Aller à la référence de l’API Document.

Export This Article

Save a copy of this page as PDF or plain text.