API un tīmekļa āķi

Kur to atrast

Ja dokumenti jūsu birojā rodas kaut kur citur, nevis DocuTract, šī sistēma var sazināties ar mums tieši. Atveriet izvēlni ar savu adresi augšējā labajā stūrī un izvēlieties Integrācijas: tur tiek izsniegts marķieris, ar kuru jūsu sistēma mūs izsauc, un tur pievienojat adresi, uz kuru mēs paziņojam par gataviem dokumentiem.

Skats sākas ar gataviem CRM savienojumiem (CRM integrācijas); šeit aprakstītie marķieri un tīmekļa āķi atrodas zem tiem, sadaļā API un tīmekļa āķi.

Marķieris

Nospiediet Izveidot marķieri, piešķiriet tam nosaukumu, ko vēlāk atpazīsiet (lai zinātu, kura sistēma to izmanto), un atzīmējiet, ko tam atļauts darīt: lasīt veidnes, veidot dokumentus, strādāt ar lietām.

Pats marķieris tiek parādīts vienreiz, uzreiz pēc izveides: mēs glabājam tikai tā jaucējvērtību, tāpēc parādīt to otrreiz nevaram pat mēs. Nokopējiet to uzreiz savas sistēmas iestatījumos.

Sarakstā redzamas katra marķiera pirmās rakstzīmes, tā atļaujas un pēdējās lietošanas laiks. Atsaukt nekavējoties izslēdz marķieri; ieraksts par to paliek, tāpēc redzams, ka tas pastāvēja un kad tas pārstāja darboties.

Ko var API

Jūsu sistēma var:

• atvērt lietu un augšupielādēt tajā skenējumus;
• izveidot dokumentu no veidnes ar jau aizpildītām vērtībām;
• uzzināt, kādā posmā ir dokuments;
• saņemt visas vērtības kopā ar skenējumu, no kura katra nolasīta;
• saņemt īslaicīgu saiti uz gatavo failu.

Pilns katras adreses un lauka apraksts tiek ģenerēts no paša koda un publicēts atklāti: API apraksts.

Tīmekļa āķi

Tā vietā, lai jautātu mums, vai dokuments ir gatavs, iedodiet mums adresi, un mēs jums rakstīsim. Pievienojiet to sadaļā Tīmekļa āķi un atzīmējiet notikumus: dokuments gatavs, dokuments neizdevās, lieta gatava, atrasta nesakritība, klients nosūtīja failu.

Katrs pieprasījums ir parakstīts ar galveni X-DocuTract-Signature, un noslēpums, ar ko pārbauda parakstu, tiek parādīts vienreiz, tāpat kā marķieris. Jūsu sistēmai jāpārbauda paraksts un jāatbild ar 2xx kodu. Ja tā atbild ar ko citu vai neatbild vispār, mēs mēģinām vēlreiz: pēc minūtes, pēc piecām, pēc pusstundas, pēc divām stundām un pēc desmit, un tad apstājamies.

Kad kaut kas nepienāca

Poga Piegādes parāda žurnālu: kuru notikumu nosūtījām, kad, cik reizes, kāds atbildes kods atgriezās un atbildes ķermeņa sākums. Tā ir atbilde uz «mūsu sistēma neko nesaņēma»: tur rakstiski redzams, ka tā četras reizes 14:12 atbildēja ar 500.

Nosūtīt testu nekavējoties nosūta uz adresi ping, negaidot īstu notikumu, lai saņēmēju varētu iestatīt, pirms caur to iet kāds darbs. Mēģināt vēlreiz blakus neizdevušās piegādei veic vēl vienu mēģinājumu nekavējoties.

Zapier, Make un n8n

No-code platformas (pakalpojumi, kuros integrāciju saliek bez programmēšanas) pašas abonē mūsu notikumus caur API REST hooks daļu, tāpēc nevienam nav jākopē to adreses DocuTract. Piešķiriet platformai marķieri ar atļaujām webhooks:read un webhooks:write, kā arī tām, kas vajadzīgas tās darbībām (piemēram, templates:read un documents:write).

• POST /api/v1/hooks ar {"event": "document.ready", "target_url": "https://…"} abonē adresi vienam notikumam. Atbildē ir abonementa id un vienreiz arī tā paraksta secret.
• GET /api/v1/hooks uzskaita šādi izveidotos abonementus; DELETE /api/v1/hooks/{id} vienu noņem.
• GET /api/v1/hooks/events uzskaita notikumus: document.ready, document.failed, case.ready, finding.raised, intake.uploaded.
• GET /api/v1/hooks/samples/{event} atgriež satura piemēru, ko platforma rāda savā “testa palaidējā”, pirms noticis kāds īsts notikums.

Abonements ir parasta tīmekļa āķa adrese: to paraksta, atkārto un reģistrē žurnālā tāpat, un tā ir redzama sarakstā Tīmekļa āķi. Tas beidzas, kad marķieris, kas to izveidoja, tiek atsaukts vai beidzas tā derīgums, vai kad platforma uz piegādi atbild ar 410 Gone.

Šādi izskatās 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"
}

un šādi 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"
}

Veidnes lauki

GET /api/v1/templates/{id}/fields (atļauja templates:read) uzskaita, kas veidnei vajadzīgs: katra lauka key (pēc tā norāda values pieprasījumā POST /api/v1/documents), tā label, no kurienes tas tiek aizpildīts, un fillable, kas ir false laukam, ko DocuTract aizpilda pats, piemēram, datumam. Veidlapa Zapier vai Make tiek veidota no šī saraksta, tāpēc vienmēr atbilst veidnei tās pašreizējā veidā.

Meklēšana

Daži izsaukumi pastāv, lai sistēma vai no-code platforma atrastu vajadzīgo, neminot:

• GET /api/v1/me (bez atļaujas) atgriež darbvietu, kurai pieder marķieris, tās plānu, kā arī paša marķiera nosaukumu un atļaujas. Tas ir vienkāršākais veids, kā pārbaudīt, vai marķieris darbojas.
• GET /api/v1/documents (atļauja documents:read) parāda dokumentus, jaunākos vispirms. Sašauriniet ar reference (precīzs DOC-… numurs), status vai template_id; limit — līdz 100, pēc noklusējuma 25.
• GET /api/v1/cases (atļauja cases:read) parāda jaunākās lietas, ja vēlaties, tikai ar vienu status, ar to pašu limit. Katrai lietai tagad ir arī created_at.
• GET /api/v1/case-types (atļauja cases:read) uzskaita lietu tipus, no kuriem var atvērt lietu.
• GET /api/v1/templates?name=… atstāj tikai veidnes, kuru nosaukumā ir šis teksts, neņemot vērā burtu reģistru.

Lapošanas apzināti nav: šie saraksti ir jaunākā atrašanai, nevis visas darbvietas eksportam.

Kurš plāns

API un tīmekļa āķi ir daļa no plāna Team. Jebkurā citā plānā jau izveidotie marķieri un adreses paliek redzami un tos var atsaukt, taču jauni netiek izsniegti, un izsaukumi ar marķieri vairs netiek apkalpoti. Salīdziniet plānus cenu lapā.