Publiskā API

REST API. JMAP. Parakstītas webhook'as. Audita žurnāls.

Verkio veidots API-first — tie paši endpoint'i, ko izmanto web lietotne, ir atvērti arī jums. REST ar OpenAPI 3.1 specifikāciju koda ģenerēšanai. Parakstītas webhook'as notikumiem, kas jums svarīgi. JMAP tiešai piekļuvei pasta protokolam. Audita žurnāls, straumējams uz jūsu SIEM.

REST

REST ar OpenAPI 3.1 specifikāciju.

Katrs endpoint'as dokumentēts vienā OpenAPI 3.1 failā. Norādiet savu koda ģenerēšanas rīku (openapi-generator, oapi-codegen, OpenAPI TS) uz /api/v1/openapi.json un saņemiet tipētu klientu jūsu izvēlētajā valodā — vai pārlūkojiet interaktīvo atsauci /developers.

  • OpenAPI 3.1 specifikācija /api/v1/openapi.json — gatava koda ģenerēšanai.
  • Interaktīva atsauce /developers (Swagger UI).
  • Bearer-token autentifikācija (RFC 6750). Atslēgas hashotas ar Argon2id miera stāvoklī.
  • Per-atslēgas ātruma ierobežojumi ar X-RateLimit-* galvenēm. 429 ar Retry-After.
  • Idempotency-Key atbalsts mutējošos endpoint'os — droši atkārtot uz nestabiliem tīkliem.

Parakstītas webhook'as

HMAC-parakstīta piegāde ar dead-letter rindu.

Abonējiet notikumus, kas jums svarīgi — jauna pasta, audita žurnāla ieraksti, konta izmaiņas. Katrs payload ir HMAC-SHA256 parakstīts, lai jūs varētu pārbaudīt, ka tas nāca no Verkio. Neveiksmīgas piegādes tiek atkārtotas ar eksponenciālu backoff; pastāvīgas kļūdas nonāk dead-letter rindā, ko varat pārbaudīt un atkārtot.

  • HMAC-SHA256 paraksts katram payload (X-Verkio-Signature galvene).
  • Eksponenciāli backoff atkārtojumi 5xx un savienojuma kļūdās.
  • Dead-letter rinda paneļa — apskatīt, atkārtot, noraidīt.
  • Katrs piegādes mēģinājums reģistrēts audita žurnālā.

JMAP caurplūde

Runājiet modernajā pasta protokolā tieši.

Verkio pamatā esošais pasta serveris runā JMAP (RFC 8620 / 8621) — moderno, JSON balstīto IMAP pēcteci. Publiskā API atklāj JMAP caurplūdi, lai klientu bibliotēkas varētu tieši runāt ar jūsu pastkastēm, neatkārtojot katru endpoint'u servera pusē.

  • JMAP Core (RFC 8620) un JMAP Mail (RFC 8621) caur /api/v1/jmap.
  • Izmantojiet jebkuru ar JMAP saderīgu klienta bibliotēku — jmap-client (JS), python-jmap, citas.
  • Push paziņojumi caur JMAP EventSource — bez polling.
  • IMAP un SMTP arī pieejami klientiem, kuriem tie nepieciešami.

Audita žurnāla API

Katra administratora darbība, straumējama.

Tas pats audita žurnāls, ko lasāt panelī, ir pieejams kā API — sadalīts lappusēs, filtrējams, ar pirms/pēc vērtībām katrai izmaiņai. Straumējiet notikumus uz Splunk, Datadog vai jebkuru SIEM, kas pieņem webhook vai pieprasa lappusēs sadalītu endpoint'u. Eksportējiet uz CSV vai JSONL kriminālekspertīzei.

  • Sadalīts lappusēs un filtrējams: pēc lietotāja, notikuma veida, datumu intervāla.
  • Pirms/pēc vērtības katrai mutācijai — pilna kriminālekspertīzes pēda.
  • Straumējiet uz savu SIEM caur webhook vai pull endpoint.
  • Eksportējiet uz CSV vai JSONL bezsaistes analīzei. Septiņus gadus saglabāšana pēc noklusējuma.

Gatavs ražošanai

Veidots ilgtermiņa integrācijām, kuras patiešām vēlaties rakstīt.

Ierobežota apjoma API atslēgas ar rotāciju. Per-atslēgas ātruma ierobežojumi. Idempotence rakstīšanā. Versionētas URL, lai novecošana jūs nepārsteigtu klusā svētdienā. Garlaicīgās garantijas, kas integrāciju padara rakstīšanas vērtu.

  • Ierobežota apjoma API atslēgas — read-only, ierobežotas pastkastei, ierobežotas organizācijai.
  • Atslēgu rotācija panelī — atsauciet un izsniedziet jaunas bez dīkstāves.
  • URL versionēšana (/api/v1/…) ar novecošanas galvenēm mēnešus iepriekš.
  • OpenAPI changelog publicēts; izšķirošas izmaiņas tikai galvenajos versiju lēcienos.

Atklātie standarti

RFC un OpenAPI. Nekas patentēts.

Katrs protokols, ko publiskā API runā, ir publiski dokumentēts. Atnesiet savu koda ģenerēšanas rīku. Atnesiet savu esošo klienta bibliotēku. Nekas šeit nav izgudrots pārdevēja prezentācijai.

  • 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

Atklāšana 2026. gada jūlijā

Pievienoties gaidīšanas sarakstam

Mēs sazināsimies, kad Verkio atvērsies.