Avalik API, webhookid ja integratsiooniressursid
Loo ja halda API võtmeid integratsioonide jaoks
Saa reaalajas teateid ärisündmustest oma süsteemi
Tee oma esimene API päring vähem kui 5 minutiga
Mine API võtmed lehele ja vajuta "Loo uus võti". Anna sellele kirjeldav nimi (nt. "Zapier integratsioon") ja vali vajalikud õigused.
Autentimiseks lisa võti Authorization päisesse kui Bearer token.
curl -X GET "https://synx.ee/api/v1/invoices?limit=10" \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"{
"data": [
{
"id": "clxxxxxx",
"number": "INV-2026-001",
"status": "PAID",
"total": 299.00,
"currency": "EUR",
"issueDate": "2026-04-01T00:00:00.000Z",
"dueDate": "2026-04-15T00:00:00.000Z"
}
],
"pagination": {
"total": 127,
"limit": 10,
"offset": 0,
"hasMore": true
}
}Kõik avaliku API päringud peavad sisaldama API võtit Authorization päises:
Authorization: Bearer sk_live_abc123_.../api/v1/invoicesNimekiri arveid (filtreeritav)/api/v1/contactsNimekiri kontakte/api/v1/contactsLoo uus kontaktMasinloetav endpointide, skeemide ja autentimise kirjeldus on avalikus OpenAPI spetsifikatsioonis.
Kõik webhook päringud on HMAC-SHA256 signeeritud. Kontrolli signatuuri enne päringu aktsepteerimist.
X-Webhook-Event: INVOICE_PAID
X-Webhook-Event-Id: uuid-v4-here
X-Webhook-Signature: sha256-hmac-heximport crypto from "crypto";
function verifyWebhook(rawBody, signature, secret) {
const expected = Buffer.from(crypto
.createHmac("sha256", secret)
.update(rawBody)
.digest("hex"), "hex");
const provided = Buffer.from(signature, "hex");
return provided.length === expected.length &&
crypto.timingSafeEqual(provided, expected);
}invoice.createdUus arve loodiinvoice.sentArve saadeti kliendileinvoice.paidArve märgiti tasutuksinvoice.overdueArve on tähtajaks tasumatacontact.createdUus kontakt loodicontact.updatedKontakt uuendatipayment.receivedMakse laekuscontract.signedLeping allkirjastatiquote.acceptedPakkumus aktsepteeritibank.transaction.importedPangatehing imporditiKui sinu endpoint tagastab mitte-2xx vastuse, proovitakse uuesti:
Pärast viiendat ebaõnnestunud katset uusi automaatseid katseid ei lisata. Vaata logi webhookide halduslehelt.
Avalikele API-päringutele rakendub praegu IP-põhine väärkasutuse kaitse kuni 300 päringut 60 sekundi kohta. Tundlikele autentimistoimingutele kehtivad rangemad piirid. Piiri ületamisel vastab API staatusega 429 ja lisabRetry-Afterpäise. Piirangud võivad turbe- ja töökindlusvajaduse järgi muutuda.