Vieša API

REST API. JMAP. Pasirašyti webhook'ai. Audito žurnalas.

Verkio sukurta API-first principu — tie patys endpoint'ai, kuriuos naudoja web aplikacija, yra atviri jums. REST su OpenAPI 3.1 specifikacija codegen'ui. Pasirašyti webhook'ai įvykiams, kurie jums svarbūs. JMAP tiesioginei prieigai prie pašto protokolo. Audito žurnalas, transliuojamas į jūsų SIEM.

UžsiregistruotiAtgal į produkto apžvalgą

REST

REST su OpenAPI 3.1 specifikacija.

Kiekvienas endpoint'as dokumentuotas viename OpenAPI 3.1 faile. Nukreipkite savo codegen įrankį (openapi-generator, oapi-codegen, OpenAPI TS) į /api/v1/openapi.json ir gaukite tipizuotą klientą norima kalba — arba naršykite interaktyvią nuorodą /developers.

  • OpenAPI 3.1 specifikacija /api/v1/openapi.json — paruošta codegen'ui.
  • Interaktyvi nuoroda /developers (Swagger UI).
  • Bearer token autentifikacija (RFC 6750). Raktai hashinami Argon2id ramybės būsenoje.
  • Per-raktas greičio ribos su X-RateLimit-* antraštėmis. 429 su Retry-After.
  • Idempotency-Key palaikymas mutuojantiems endpoint'ams — saugu pakartoti nestabiliuose tinkluose.

Pasirašyti webhook'ai

HMAC pasirašytas pristatymas su dead-letter eile.

Užsiprenumeruokite įvykius, kurie jums svarbūs — naujas paštas, audito žurnalo įrašai, paskyros pakeitimai. Kiekvienas payload pasirašytas HMAC-SHA256, todėl galite patvirtinti, kad jis atėjo iš Verkio. Nepavykę pristatymai pakartojami su eksponentiniu backoff'u; nuolatinės klaidos patenka į dead-letter eilę, kurią galite peržiūrėti ir pakartoti.

  • HMAC-SHA256 parašas kiekvienam payload (X-Verkio-Signature antraštė).
  • Eksponentiniai backoff pakartojimai esant 5xx ir ryšio klaidoms.
  • Dead-letter eilė skydelyje — peržiūrėti, pakartoti, atmesti.
  • Kiekvienas pristatymo bandymas užregistruotas audito žurnale.

JMAP perdavimas

Kalbėkite šiuolaikiniu pašto protokolu tiesiogiai.

Pagrindinis Verkio pašto serveris kalba JMAP (RFC 8620 / 8621) — šiuolaikinį, JSON pagrindu sukurtą IMAP įpėdinį. Viešoji API atskleidžia JMAP perdavimą, kad kliento bibliotekos galėtų bendrauti su jūsų pašto dėžutėmis tiesiogiai, nepakartodamos kiekvieno endpoint'o serverio pusėje.

  • JMAP Core (RFC 8620) ir JMAP Mail (RFC 8621) per /api/v1/jmap.
  • Naudokite bet kokią su JMAP suderinamą kliento biblioteką — jmap-client (JS), python-jmap, kitas.
  • Push pranešimai per JMAP EventSource — be polling'o.
  • IMAP ir SMTP taip pat prieinami klientams, kuriems jie reikalingi.

Audito žurnalo API

Kiekvienas administratoriaus veiksmas, transliuojamas.

Tas pats audito žurnalas, kurį skaitote skydelyje, prieinamas kaip API — su puslapiavimu, filtruojamas, su prieš/po reikšmėmis kiekvienam pakeitimui. Transliuokite įvykius į Splunk, Datadog ar bet kokį SIEM, kuris priima webhook arba apklausia puslapiuojamą endpoint'ą. Eksportuokite į CSV arba JSONL teisminei analizei.

  • Su puslapiavimu ir filtruojamas: pagal vartotoją, įvykio tipą, datų intervalą.
  • Prieš/po reikšmės kiekvienam pakeitimui — pilnas teisminis pėdsakas.
  • Transliuokite į savo SIEM per webhook arba pull endpoint'ą.
  • Eksportuokite į CSV arba JSONL atjungtai analizei. Septyneri metai saugojimo pagal nutylėjimą.

Paruošta produkcijai

Sukurta ilgalaikėms integracijoms, kurias iš tikrųjų norite rašyti.

Apriboto veikimo srities API raktai su rotacija. Per-raktas greičio ribos. Idempotencija rašymuose. Versijuoti URL, kad pasenimas jūsų nenustebintų ramų sekmadienį. Nuobodžios garantijos, dėl kurių verta rašyti integraciją.

  • Apriboto veikimo srities API raktai — read-only, apriboti pašto dėžutei, apriboti organizacijai.
  • Raktų rotacija skydelyje — atšaukite ir išduokite naujus be prastovų.
  • URL versijavimas (/api/v1/…) su pasenimo antraštėmis mėnesiais į priekį.
  • OpenAPI changelog paskelbtas; nesuderinami pakeitimai tik major versijos šuoliuose.

Atviri standartai

RFC ir OpenAPI. Nieko nuosavybinio.

Kiekvienas protokolas, kuriuo kalba viešoji API, yra viešai dokumentuotas. Atsineškite savo codegen įrankį. Atsineškite savo esamą kliento biblioteką. Nieko čia nesugalvota pardavėjo pristatymui.

  • 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

Pristatymas 2026 m. liepą

Užsiregistruoti į laukimo sąrašą

Mes susisieksime, kai Verkio atsidarys.