Opinber API
REST API. JMAP. Undirritaðir webhookar. Úttektarskráin.
Verkio er byggt API-first — sömu endapunktarnir og vefappið notar eru opnir þér. REST með OpenAPI 3.1 skjali fyrir kóða-myndun. Undirritaðir webhookar fyrir atburðina sem þér er annt um. JMAP til beins aðgangs að póstsamskiptareglunni. Úttektarskráin straumanleg yfir í SIEM-ið þitt.
REST
REST með OpenAPI 3.1 skjali.
Sérhver endapunktur skjalfestur í einni OpenAPI 3.1 skrá. Beindu kóða-myndunartólinu þínu (openapi-generator, oapi-codegen, OpenAPI TS) að /api/v1/openapi.json og fáðu týpuðum biðlara í tungumálinu sem þú vilt — eða flettu gagnvirku heimildinni á /developers.
- OpenAPI 3.1 skjal á /api/v1/openapi.json — tilbúið fyrir kóða-myndun.
- Gagnvirk heimild á /developers (Swagger UI).
- Bearer-tákns auðkenning (RFC 6750). Lyklar hashaðir með Argon2id í hvíld.
- Per-lykils hraðatakmörk með X-RateLimit-* haus. 429-ir með Retry-After.
- Idempotency-Key stuðningur á breytandi endapunktum — öruggt að reyna aftur á óstöðugum netum.
Undirritaðir webhookar
HMAC-undirrituð afhending með dead-letter biðröð.
Skráðu þig á atburðina sem þér er annt um — nýr póstur, færslur í úttektarskrá, reikningsbreytingar. Hver burður er HMAC-SHA256-undirritaður svo þú getur sannreynt að hann komi frá Verkio. Misheppnaðar afhendingar eru endurteknar með veldisvísis-backoff; viðvarandi villur lenda í dead-letter biðröð sem þú getur skoðað og endurspilað.
- HMAC-SHA256 undirskrift á hvern burð (X-Verkio-Signature haus).
- Veldisvísis backoff-endurtekningar á 5xx og tengingarvillum.
- Dead-letter biðröð í stjórnborði — skoðaðu, endurspilaðu, hafnaðu.
- Sérhver afhendingartilraun skráð í úttektarskrá.
JMAP pössun
Talaðu nútíma póstsamskiptaregluna beint.
Undirliggjandi póstþjónn Verkio talar JMAP (RFC 8620 / 8621) — nútíma, JSON-byggðan arftaka IMAP. Opinbera API-ið birtir JMAP pössun svo biðlarasöfn geti talað beint við pósthólfin þín án þess að endurútfæra hvern endapunkt á þjóns hliðinni.
- JMAP Core (RFC 8620) og JMAP Mail (RFC 8621) yfir /api/v1/jmap.
- Notaðu hvaða JMAP-samhæfan biðlarasafn sem er — jmap-client (JS), python-jmap, önnur.
- Push-tilkynningar í gegnum JMAP EventSource — engin polling.
- IMAP og SMTP einnig í boði fyrir biðlara sem þurfa þá.
API úttektarskrár
Sérhver stjórnandaaðgerð, straumanleg.
Sama úttektarskrá og þú lest í stjórnborði er aðgengileg sem API — síðuskipt, sía-anleg, með fyrir/eftir-gildum á hverri breytingu. Streymdu atburðum til Splunk, Datadog eða hvaða SIEM sem tekur við webhook eða spyr síðuskipt endapunkt. Flyttu út í CSV eða JSONL fyrir réttarrannsóknir.
- Síðuskipt og sía-anleg: eftir notanda, atburðartegund, dagsetningarbili.
- Fyrir/eftir-gildi á hverri stökkbreytingu — fullkomið réttarslóð.
- Streymdu til SIEM þíns í gegnum webhook eða pull endapunkt.
- Flyttu út í CSV eða JSONL fyrir offline greiningu. Sjö ára varðveisla sjálfgefið.
Tilbúið fyrir framleiðslu
Byggt fyrir langtímasamþættingar sem þú vilt í raun skrifa.
Sviðstakmarkaðir API-lyklar með snúningi. Per-lykils hraðatakmörk. Idempotenssa á skrifum. Útgáfumerktar URLs svo úrelding komi þér ekki á óvart á rólegum sunnudegi. Leiðinlegu ábyrgðirnar sem gera samþættingu þess virði að skrifa.
- Sviðstakmarkaðir API-lyklar — read-only, takmarkaðir við pósthólf, takmarkaðir við stofnun.
- Lyklasnúningur í stjórnborði — afturkalla og gefa út nýja án niðurítíma.
- URL-útgáfumerkt (/api/v1/…) með úreldingarhausum mánuðum fyrirfram.
- OpenAPI breytingaskrá birt; brjótandi breytingar aðeins á aðalútgáfubreytingum.
Opnir staðlar
RFC-ar og OpenAPI. Ekkert lokað.
Sérhver samskiptaregla sem opinbera API-ið talar er opinberlega skjalfest. Komdu með kóða-myndunartólið þitt. Komdu með núverandi biðlarasafn. Ekkert hér er fundið upp fyrir söluræðu.
- OpenAPI 3.1
- REST
- JMAP Core (RFC 8620)
- JMAP Mail (RFC 8621)
- Bearer auth (RFC 6750)
- HMAC-SHA256 (RFC 6234)
- Argon2id key hashing
- TLS 1.3
Kemur út í júlí 2026
Skráðu þig á biðlistann
Við höfum samband þegar Verkio opnar.