Avalik API

REST API. JMAP. Allkirjastatud webhookid. Audit-log.

Verkio on ehitatud API-first — samad endpoindid, mida veebirakendus kasutab, on avatud ka sulle. REST koos OpenAPI 3.1 spetsifikatsiooniga codegen'i jaoks. Allkirjastatud webhookid sündmuste jaoks, mis sind huvitavad. JMAP otsejuurdepääsuks postiprotokollile. Audit-log, mida saab oma SIEM-i voogedastada.

Liitu ootejärjekorragaTagasi tooteülevaate juurde

REST

REST OpenAPI 3.1 spetsifikatsiooniga.

Iga endpoint dokumenteeritud ühes OpenAPI 3.1 failis. Suuna oma codegen-tööriist (openapi-generator, oapi-codegen, OpenAPI TS) aadressile /api/v1/openapi.json ja saa tüübitud klient sinu eelistatud keeles — või sirvi interaktiivset viidet aadressil /developers.

  • OpenAPI 3.1 spetsifikatsioon aadressil /api/v1/openapi.json — codegen-valmis.
  • Interaktiivne viide aadressil /developers (Swagger UI).
  • Bearer-tokeni autentimine (RFC 6750). Võtmed hashitud Argon2id-ga puhkeolekus.
  • Per-võtme rate-limiidid X-RateLimit-* päistega. 429-d Retry-After-iga.
  • Idempotency-Key tugi muteerivatel endpointidel — turvaline korrata ebakindlatel võrkudel.

Allkirjastatud webhookid

HMAC-allkirjastatud kohaletoimetamine dead-letter järjekorraga.

Telli sündmused, mis sind huvitavad — uus post, audit-logi kirjed, kontomuudatused. Iga payload on HMAC-SHA256-ga allkirjastatud, nii et saad kinnitada, et see tuli Verkio'st. Ebaõnnestunud kohaletoimetamisi korratakse eksponentsiaalse backoffiga; püsivad tõrked jõuavad dead-letter järjekorda, mida saad vaadata ja uuesti taasesitada.

  • HMAC-SHA256 allkiri payloadi kohta (X-Verkio-Signature päis).
  • Eksponentsiaalse backoffiga kordused 5xx ja ühendusvigade korral.
  • Dead-letter järjekord töölaual — vaata, taasesita, jäta kõrvale.
  • Iga kohaletoimetamiskatse logitud audit-logis.

JMAP passthrough

Räägi otse moodsa postiprotokolliga.

Verkio aluseks olev postiserver räägib JMAP-i (RFC 8620 / 8621) — moodsat, JSON-põhist IMAP-i järeltulijat. Avalik API pakub JMAP passthrough'i, nii et kliendi raamatukogud saavad rääkida sinu postkastidega otse, ilma et iga endpointi peaks serveri poolel uuesti rakendama.

  • JMAP Core (RFC 8620) ja JMAP Mail (RFC 8621) üle /api/v1/jmap.
  • Kasuta ükskõik millist JMAP-ühilduvat klienditeeki — jmap-client (JS), python-jmap, teisi.
  • Push-teavitused JMAP EventSource kaudu — ilma pollinguta.
  • IMAP ja SMTP on samuti saadaval klientidele, kes neid vajavad.

Audit-logi API

Iga admin-toiming, voogedastatav.

Sama audit-log, mida loed töölaual, on saadaval API-na — lehekülgedeks jagatud, filtreeritav, iga muudatuse juures enne/pärast väärtustega. Voogedasta sündmusi Splunki, Datadogi või ükskõik millisesse SIEM-i, mis aktsepteerib webhooki või pollib lehekülgedeks jagatud endpointi. Ekspordi CSV-sse või JSONL-i kohtuekspertiisi jaoks.

  • Lehekülgedeks jagatud ja filtreeritav: kasutaja, sündmuse tüübi, kuupäevavahemiku järgi.
  • Iga mutatsiooni enne/pärast väärtused — täielik kohtuekspertiisi rada.
  • Voogedasta oma SIEM-i webhooki või pull-endpointi kaudu.
  • Ekspordi CSV-sse või JSONL-i offline-analüüsiks. Vaikimisi seitse aastat säilitamist.

Produktsiooniks valmis

Ehitatud pikaajaliste integratsioonide jaoks, mida sa tegelikult kirjutada tahad.

Scope'itud API-võtmed rotatsiooniga. Per-võtme rate-limiidid. Idempotentsus kirjutamisel. Versioonitud URL-id, nii et aegunuks tunnistamine ei taba sind vaiksel pühapäeval. Igavad garantiid, mis teevad integratsiooni kirjutamise vääriliseks.

  • Scope'itud API-võtmed — read-only, ühe postkasti, ühe organisatsiooni piires.
  • Võtmerotatsioon töölaual — tühista ja anna välja uued ilma seisakuta.
  • URL-versioneeritud (/api/v1/…) deprekatsioonipäistega kuude kaupa ette.
  • OpenAPI changelog avaldatud; murdvad muudatused ainult suuremate versioonihüpete korral.

Avatud standardid

RFC-d ja OpenAPI. Mitte midagi omandiõigust.

Iga protokoll, mida avalik API räägib, on avalikult dokumenteeritud. Too oma codegen-tööriist. Too oma olemasolev klienditeek. Mitte midagi siin pole välja mõeldud müügiesitluse jaoks.

  • 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

Avaldame juulis 2026

Liitu ootejärjekorraga

Võtame ühendust, kui Verkio avaneb.