So führen Sie eine Übernacht-Synchronisierung durch

Problem / Lösung

Problem: Webhooks aktualisieren Ihr System, aber Sie müssen ganz sicher sein, dass Ihre Dokumente alle richtig synchronisiert sind.

Lösung: Eine Dokumentabfrage, die Sie jede Nacht ausführen können und die alles zurückgibt, was seit der vorherigen Nacht passiert ist.

So geht's

Fügen Sie einfach 'modified_gt=' zur /api/v1/document-Abfrage hinzu.

z.B. Holen Sie bis zu 500 Dokumente, die seit einem vorherigen Datum-/Zeitpunkt geändert wurden (ohne Unterschreiber-Details).

/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]

Tipp

Diese Abfrage enthält den Parameter nosigners=1. Wenn Sie keine Informationen zum Status der Unterzeichner benötigen (vielleicht benötigen Sie nur den Dokumentstatus), wird Ihre Abfrage dadurch deutlich schneller. Beschleunigen Sie die Abfrage weiter, indem Sie einen großen limit-Wert verwenden. (Zum Dokumentstatus-Referenzleitfaden).

Der Parameter offset iteriert die Liste. Durch einfaches Iterieren Ihrer Dokumente erhalten Sie die nächste Abfrage-URL aus dem 'next'-Element innerhalb des 'meta'-Objekts einer Antwort. Wenn der next-Wert null ist, gibt es keine weiteren Elemente zu holen.

Beispielantwort inklusive '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,

Zur Dokument-API-Referenz.