Liigu sisu juurde

Arendaja dokumentatsioon

Aeglio veebihaagid

Võta valitud ärisündmusi oma süsteemis vastu nende toimumisel. Iga edastus allkirjastatakse, versioonitakse ja saadetakse vajaduse korral uuesti väljaspool sinu tavapärast Aeglio töövoogu.

Proovi tasuta API dokumentatsioon

Kiire algus

Loo vastuvõtupunkt ja vali selle sündmused.

  1. 1Loo avalik HTTPS-vastuvõtupunkt, mis võtab vastu JSON POST-päringuid.
  2. 2Ava Aeglios Seaded → Arendajad → Veebihaagid ning lisa vastuvõtuaadress ja sündmused.
  3. 3Salvesta ainult üks kord kuvatav allkirjastamisvõti, kontrolli iga päringu allkirja ja tagasta 2xx-vastus.

Edastuse vorming

Aeglio saadab seadistatud vastuvõtupunkti JSON POST-päringu. Sisu on versioonitud, et vastuvõtja saaks kasutada teadaolevat andmelepingut. Iga sündmuse objekti tunnus on data.id; seoseväljad, näiteks client_id kasutavad samu ID-sid nagu API.

{
  "id": "event UUID",
  "type": "invoice.paid",
  "version": 1,
  "occurred_at": "2026-08-09T12:00:00.000000Z",
  "data": { "…": "event-specific fields" }
}

Sündmuste *.updated puhul sisaldab väli data.changed_fields muudetud väljade nimede JSON-massiivi, näiteks ["status", "due_date"].

Pakkumissündmused tuvastavad konkreetse versiooni väljaga data.id, data.revision_number ning pärast esimest versiooni ka väljaga data.previous_revision_id. Sündmus estimate.superseded tähendab, et uuem versioon asendas selle versiooni, samal ajal kui estimate.cancelled tähendab, et meeskond võttis selle versiooni tagasi.

PäisOtstarve
X-Aeglio-EventSündmuse nimi, näiteks invoice.paid.
X-Aeglio-Event-IdKordumatu sündmuse ID. Salvesta see korduva töötlemise vältimiseks.
X-Aeglio-Webhook-VersionAndmesisu versioon.
X-Aeglio-TimestampAllkirjas sisalduv Unixi ajatempel.
X-Aeglio-SignatureAllkiri kujul v1=<hex digest>.

Allkirjade kontroll

Kasuta päringu täpset töötlemata sisu enne parsimist või ümbervormindamist. Arvuta HMAC-SHA256 ajatemplist, punktist ja töötlemata sisust, kasutades vastuvõtupunkti allkirjastamisvõtit.

expected = HMAC_SHA256(
  timestamp + "." + raw_request_body,
  signing_secret
)

X-Aeglio-Signature = "v1=" + expected
  • Võrdle allkirju ajastusrünnakutele vastupidava võrdlusega.
  • Lükka vana ajatempliga päringud tagasi, et vähendada taasesituse riski.
  • Salvesta iga sündmuse ID pärast edukat töötlemist, et korduskatse ei tekitaks topelttööd.

Töökindlus

Kiire kinnitus, turvaline taastamine.

Iga 2xx-vastus lõpetab edastuse. Teiste vastuste ja ühendusvigade korral proovitakse kasvavate viivitustega uuesti kuni 5 korda. Aeglio peatab vastuvõtupunkti automaatselt pärast 10 järjestikust lõplikult ebaõnnestunud edastust, et tõrkuv vastuvõtja ei tekitaks piiramatut tööd.

Halda tellimusi API kaudu

Meeskonnad saavad Aeglio API kaudu veebihaagitellimusi ka luua, muuta, peatada, jätkata ja kustutada. Kasuta õigust webhooks:read tellimuste ja edastusajaloo vaatamiseks ning õigust webhooks:manage nende muutmiseks.

Allkirjastamisvõti tagastatakse ainult tellimuse loomisel või võtme vahetamisel. Seda ei lisata tavalistesse API lugemisvastustesse.

Ava veebihaakide API dokumentatsioon

Saadaolevad sündmused

Vali ainult sündmused, mida su vastuvõtja vajab. Üks vastuvõtupunkt võib tellida sündmusi rohkem kui ühest rühmast.

Kliendid, tarnijad ja kontaktid

counterparty.created counterparty.updated counterparty.deleted contact.created contact.updated contact.deleted

Projektid

project.created project.updated project.archived project.unarchived project.deleted

Müük ja pakkumised

deal.created deal.updated deal.won deal.lost deal.deleted estimate.created estimate.updated estimate.sent estimate.viewed estimate.accepted estimate.rejected estimate.expired estimate.superseded estimate.cancelled estimate.deleted

Arved

invoice.created invoice.updated invoice.sent invoice.paid invoice.overdue invoice.refunded invoice.payment_received

Kulud

expense.created expense.updated expense.payment_received expense.paid expense.overdue expense.deleted expense.approved

Hüvitised

reimbursement.approved reimbursement.partially_paid reimbursement.paid reimbursement.reversed

Dokumendid

document.received document.deleted document.ready_for_review document.converted document.failed

Kinnitused

approval.requested approval.step_advanced approval.decided approval.recalled

Raamatupidamine ja liidestused

accounting_export.sent accounting_export.failed integration.connected integration.disconnected integration.failed