API ja veebihaagid

Kust seda leida

Kui sinu kontoris saavad dokumendid alguse mujal kui DocuTractis, saab see süsteem meiega otse suhelda. Ava paremas ülanurgas sinu aadressiga menüü ja vali Integratsioonid: seal väljastatakse token, millega sinu süsteem meid kutsub, ja seal lisad aadressi, millele teatame valmis dokumentidest.

Vaade algab valmis CRM-i ühendustega (CRM-i integratsioonid); siin kirjeldatud tokenid ja veebihaagid on nende all, jaotises API ja veebihaagid.

Token

Vajuta Loo token, anna sellele nimi, mille hiljem ära tunned (et teaksid, milline süsteem seda kasutab), ja märgi, mida sellel lubatakse teha: lugeda malle, luua dokumente, töötada juhtumitega.

Tokenit ennast näidatakse ühe korra, kohe pärast loomist: salvestame ainult selle räsi, nii et teist korda näidata ei saa seda isegi meie. Kopeeri see otse oma süsteemi seadetesse.

Loendis on näha iga tokeni esimesed märgid, mida see teha tohib ja millal seda viimati kasutati. Tühista lülitab tokeni kohe välja; kirje sellest jääb alles, nii et on näha, et see oli olemas ja millal see töötamast lakkas.

Mida API teha oskab

Sinu süsteem saab:

• avada juhtumi ja laadida sinna skaneeringuid;
• luua malli põhjal dokumendi juba täidetud väärtustega;
• küsida, millises etapis dokument on;
• võtta kõik väärtused koos skaneeringuga, millest igaüks loeti;
• saada valmis failile lühiajalise lingi.

Iga aadressi ja välja täielik kirjeldus genereeritakse koodist endast ja avaldatakse avalikult: API kirjeldus.

Veebihaagid

Selle asemel et meilt küsida, kas dokument on valmis, anna meile aadress ja me kirjutame sulle. Lisa see jaotises Veebihaagid ja märgi sündmused: dokument valmis, dokument ebaõnnestus, juhtum valmis, leiti lahknevus, klient saatis faili.

Iga päring on allkirjastatud päisega X-DocuTract-Signature ja saladust, millega allkirja kontrollitakse, näidatakse ühe korra, nagu tokenitki. Sinu süsteem peab allkirja kontrollima ja vastama 2xx koodiga. Kui see vastab millegi muuga või ei vasta üldse, proovime uuesti: minuti pärast, viie minuti pärast, poole tunni pärast, kahe tunni pärast ja kümne tunni pärast ning siis lõpetame.

Kui midagi ei saabunud

Nupp Kohaletoimetamised näitab logi: millise sündmuse saatsime, millal, mitu korda, milline vastuskood tuli ja vastuse sisu algus. See on vastus väitele „meie süsteem ei saanud midagi“: seal on kirjalikult, et see vastas kell 14:12 neli korda koodiga 500.

Saada test postitab aadressile kohe ping-i, ootamata päris sündmust, nii et vastuvõtja saab seadistada enne, kui sellest läbi läheb päris töö. Proovi uuesti ebaõnnestunud kohaletoimetamise kõrval teeb kohe veel ühe katse.

Zapier, Make ja n8n

No-code platvormid (teenused, kus integratsioon pannakse kokku programmeerimata) tellivad meie sündmused ise API REST hooks osa kaudu, nii et kellelgi pole vaja nende aadresse DocuTracti kopeerida. Anna platvormile token õigustega webhooks:read ja webhooks:write ning nendega, mida selle toimingud vajavad (näiteks templates:read ja documents:write).

• POST /api/v1/hooks sisuga {"event": "document.ready", "target_url": "https://…"} tellib aadressile ühe sündmuse. Vastus sisaldab tellimuse id-d ja ühe korra selle allkirja secret-it.
• GET /api/v1/hooks loetleb nii loodud tellimused; DELETE /api/v1/hooks/{id} eemaldab ühe.
• GET /api/v1/hooks/events loetleb sündmused: document.ready, document.failed, case.ready, finding.raised, intake.uploaded.
• GET /api/v1/hooks/samples/{event} tagastab sisu näite, mida platvorm näitab oma „testpäästikus“ enne, kui ükski päris sündmus on toimunud.

Tellimus on tavaline veebihaagi aadress: seda allkirjastatakse, korratakse ja logitakse samamoodi ning see on näha nimekirjas Veebihaagid. See lõpeb, kui selle loonud token tühistatakse või aegub või kui platvorm vastab kohaletoimetamisele koodiga 410 Gone.

Nii näeb välja document.ready:

{
  "document_id": "00000000-0000-4000-8000-000000000001",
  "reference": "DOC-26-0001",
  "template_id": "00000000-0000-4000-8000-000000000002",
  "template_version": 1,
  "event": "document.ready",
  "occurred_at": "2026-01-15T10:30:00+00:00"
}

ja nii case.ready:

{
  "case_id": "00000000-0000-4000-8000-000000000003",
  "title": "Sample case",
  "documents": [
    { "id": "00000000-0000-4000-8000-000000000001", "reference": "DOC-26-0001" }
  ],
  "event": "case.ready",
  "occurred_at": "2026-01-15T10:30:00+00:00"
}

Malli väljad

GET /api/v1/templates/{id}/fields (õigus templates:read) loetleb, mida mall vajab: iga välja key (mille järgi antakse values päringus POST /api/v1/documents), selle label, kust see täidetakse, ja fillable, mis on false välja puhul, mille DocuTract täidab ise, näiteks kuupäev. Zapieri või Make'i vorm ehitatakse sellest nimekirjast, nii et see vastab alati mallile selle praegusel kujul.

Otsingud

Mõni päring on olemas selleks, et süsteem või no-code platvorm leiaks vajaliku ilma arvamata:

• GET /api/v1/me (õigust pole vaja) tagastab tööruumi, kuhu token kuulub, selle paketi ning tokeni enda nime ja õigused. See on lihtsaim viis kontrollida, et token töötab.
• GET /api/v1/documents (õigus documents:read) näitab dokumente, uusimad eespool. Kitsenda parameetritega reference (täpne DOC-… viide), status või template_id; limit on kuni 100, vaikimisi 25.
• GET /api/v1/cases (õigus cases:read) näitab uusimaid juhtumeid, soovi korral ainult ühe status väärtusega, sama limit piiranguga. Igal juhtumil on nüüd ka created_at.
• GET /api/v1/case-types (õigus cases:read) loetleb juhtumitüübid, millest juhtumi saab avada.
• GET /api/v1/templates?name=… jätab alles ainult mallid, mille nimes tekst esineb, tõstutundetult.

Lehekülgedeks jagamist pole meelega: need loendid on uusima leidmiseks, mitte terve tööruumi eksportimiseks.

Milline pakett

API ja veebihaagid kuuluvad Team paketti. Igas muus paketis jäävad juba loodud tokenid ja aadressid nähtavaks ja neid saab tühistada, kuid uusi ei väljastata ja tokeniga tehtud kutseid enam ei teenindata. Võrdle pakette hinnalehel.