SynxAlusta tasuta

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

Masinloetav endpointide, skeemide ja autentimise kirjeldus on avalikus OpenAPI spetsifikatsioonis.

Webhooks

Sündmused ja signatuurid

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

Saabuvad päised

X-Webhook-Event: INVOICE_PAID
X-Webhook-Event-Id: uuid-v4-here
X-Webhook-Signature: sha256-hmac-hex
http

Signatuuri kontroll (Node.js)

import 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);
}
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

Pärast viiendat ebaõnnestunud katset uusi automaatseid katseid ei lisata. Vaata logi webhookide halduslehelt.

Rate limits

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.

Täielik dokumentatsioon

Ava masinloetav OpenAPI spetsifikatsioon endpointide, parameetrite ja vastuseskeemidega.