Arendajad

Avalik API, webhookid ja integratsiooniressursid

API võtmed

Loo ja halda API võtmeid integratsioonide jaoks

Halda

Webhookid

Saa reaalajas teateid ?risündmustest oma s?steemi

Halda

Kiire start

Tee oma esimene API päring v?hem kui 5 minutiga

Alusta

Kiire start

1. Loo API v?ti

Mine API võtmed lehele ja vajuta "Loo uus v?ti". Anna sellele kirjeldav nimi (nt. "Zapier integratsioon") ja vali vajalikud õigused.

2. Tee oma esimene päring

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"

bash

3. Töötle vastust

{
  "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
  }
}

json

Autentimine

Kõik avaliku API päringud peavad sisaldama API v?tit Authorization p?ises:

Authorization: Bearer sk_live_abc123_...

http

READ

Ainult GET päringud (lugemine)

WRITE

GET + POST + PATCH + DELETE (muutmine)

ADMIN

Kõik õigused, sh. tundlikud operatsioonid

REST API endpointid

GET/api/v1/invoicesNimekiri arveid (filtreeritav)

READ

GET/api/v1/contactsNimekiri kontakte

READ

POST/api/v1/contactsLoo uus kontakt

WRITE

Rohkem endpointe tuleb peatselt juurde. Vaata t?ielikku dokumentatsiooni API viite lehelt.

Webhooks

S?ndmused ja signatuurid

Kõik webhook päringud on HMAC-SHA256 signeeritud. Kontrolli signatuuri enne päringu aktsepteerimist.

Saabuvad p?ised

X-Synx-Event: INVOICE_PAID
X-Synx-Event-Id: uuid-v4-here
X-Synx-Signature: sha256-hmac-hex
X-Synx-Timestamp: 1712745600
X-Synx-Delivery: cuid-delivery-id

http

Signatuuri kontroll (Node.js)

import crypto from "crypto";

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(payload)
    .digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(signature, "hex"),
    Buffer.from(expected, "hex")
  );
}

javascript

Toetatud s?ndmused

invoice.createdUus arve loodi

invoice.sentArve saadeti kliendile

invoice.paidArve m?rgiti tasutuks

invoice.overdueArve on tähtajaks tasumata

contact.createdUus kontakt loodi

contact.updatedKontakt uuendati

payment.receivedMakse laekus

contract.signedLeping allkirjastati

quote.acceptedPakkumus aktsepteeriti

bank.transaction.importedPangatehing imporditi

Retry poliitika

Kui sinu endpoint tagastab mitte-2xx vastuse, proovitakse uuesti:

1. katse kohe
2. katse 1 minuti p?rast
3. katse 5 minuti p?rast
4. katse 30 minuti p?rast
5. katse 2 tunni p?rast
Viimane katse 24 tunni p?rast

Pärast 5 j?rjestikust eba?nnestumist l?litatakse webhook automaatselt v?lja. Vaata logi webhookide halduslehelt.

Rate limits

Plaan	P?ringuid minutis	P?ringuid päevas
Free	-	-
Pro	60	10 000
Business	300	100 000
Enterprise	1000	Piiramata

T?ielik dokumentatsioon

Vaata t?ielikku API viidet k?igi endpointide, parameetrite, vastuste ja näidetega.

Arendajad

Avalik API, webhookid ja integratsiooniressursid

API võtmed

Loo ja halda API võtmeid integratsioonide jaoks

Halda

Webhookid

Saa reaalajas teateid ?risündmustest oma s?steemi

Halda

Kiire start

Tee oma esimene API päring v?hem kui 5 minutiga

Alusta

Kiire start

1. Loo API v?ti

Mine API võtmed lehele ja vajuta "Loo uus v?ti". Anna sellele kirjeldav nimi (nt. "Zapier integratsioon") ja vali vajalikud õigused.

2. Tee oma esimene päring

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"

bash

3. Töötle vastust

{
  "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
  }
}

json

Autentimine

Kõik avaliku API päringud peavad sisaldama API v?tit Authorization p?ises:

Authorization: Bearer sk_live_abc123_...

http

READ

Ainult GET päringud (lugemine)

WRITE

GET + POST + PATCH + DELETE (muutmine)

ADMIN

Kõik õigused, sh. tundlikud operatsioonid

REST API endpointid

GET/api/v1/invoicesNimekiri arveid (filtreeritav)

READ

GET/api/v1/contactsNimekiri kontakte

READ

POST/api/v1/contactsLoo uus kontakt

WRITE

Rohkem endpointe tuleb peatselt juurde. Vaata t?ielikku dokumentatsiooni API viite lehelt.

Webhooks

S?ndmused ja signatuurid

Kõik webhook päringud on HMAC-SHA256 signeeritud. Kontrolli signatuuri enne päringu aktsepteerimist.

Saabuvad p?ised

X-Synx-Event: INVOICE_PAID
X-Synx-Event-Id: uuid-v4-here
X-Synx-Signature: sha256-hmac-hex
X-Synx-Timestamp: 1712745600
X-Synx-Delivery: cuid-delivery-id

http

Signatuuri kontroll (Node.js)

import crypto from "crypto";

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(payload)
    .digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(signature, "hex"),
    Buffer.from(expected, "hex")
  );
}

javascript

Toetatud s?ndmused

invoice.createdUus arve loodi

invoice.sentArve saadeti kliendile

invoice.paidArve m?rgiti tasutuks

invoice.overdueArve on tähtajaks tasumata

contact.createdUus kontakt loodi

contact.updatedKontakt uuendati

payment.receivedMakse laekus

contract.signedLeping allkirjastati

quote.acceptedPakkumus aktsepteeriti

bank.transaction.importedPangatehing imporditi

Retry poliitika

Kui sinu endpoint tagastab mitte-2xx vastuse, proovitakse uuesti:

1. katse kohe
2. katse 1 minuti p?rast
3. katse 5 minuti p?rast
4. katse 30 minuti p?rast
5. katse 2 tunni p?rast
Viimane katse 24 tunni p?rast

Pärast 5 j?rjestikust eba?nnestumist l?litatakse webhook automaatselt v?lja. Vaata logi webhookide halduslehelt.

Rate limits

Plaan	P?ringuid minutis	P?ringuid päevas
Free	-	-
Pro	60	10 000
Business	300	100 000
Enterprise	1000	Piiramata

T?ielik dokumentatsioon

Vaata t?ielikku API viidet k?igi endpointide, parameetrite, vastuste ja näidetega.