API pública

Uma API REST. JMAP. Webhooks assinados. O registo de auditoria.

O Verkio é construído API-first — os mesmos endpoints que a aplicação web usa estão abertos para ti. REST com uma especificação OpenAPI 3.1 para codegen. Webhooks assinados para os eventos que te interessam. JMAP para acesso direto ao protocolo de correio. O registo de auditoria transmissível para o teu SIEM.

Entrar na listaVoltar à visão geral do produto

REST

REST com uma especificação OpenAPI 3.1.

Cada endpoint documentado num único ficheiro OpenAPI 3.1. Aponta a tua ferramenta de codegen (openapi-generator, oapi-codegen, OpenAPI TS) para /api/v1/openapi.json e obtém um cliente tipado na linguagem que preferires — ou navega pela referência interativa em /developers.

  • Especificação OpenAPI 3.1 em /api/v1/openapi.json — pronta para codegen.
  • Referência interativa em /developers (Swagger UI).
  • Autenticação Bearer token (RFC 6750). Chaves hasheadas com Argon2id em repouso.
  • Rate limits por chave com cabeçalhos X-RateLimit-*. 429s com Retry-After.
  • Suporte Idempotency-Key em endpoints mutantes — seguro repetir em redes instáveis.

Webhooks assinados

Entrega assinada HMAC com fila dead-letter.

Subscreve os eventos que te interessam — novo correio, entradas do registo de auditoria, alterações de conta. Cada payload é assinado HMAC-SHA256 para que possas verificar que veio do Verkio. As entregas falhadas são repetidas com backoff exponencial; falhas persistentes acabam numa fila dead-letter que podes inspecionar e reproduzir.

  • Assinatura HMAC-SHA256 por payload (cabeçalho X-Verkio-Signature).
  • Tentativas com backoff exponencial em 5xx e erros de ligação.
  • Fila dead-letter no painel — inspecionar, reproduzir, descartar.
  • Cada tentativa de entrega registada no registo de auditoria.

Passthrough JMAP

Fala diretamente o protocolo moderno de correio.

O servidor de correio subjacente do Verkio fala JMAP (RFC 8620 / 8621) — o sucessor moderno do IMAP baseado em JSON. A API pública expõe um passthrough JMAP para que as bibliotecas cliente possam falar diretamente com as tuas caixas sem reimplementar cada endpoint do lado do servidor.

  • JMAP Core (RFC 8620) e JMAP Mail (RFC 8621) sobre /api/v1/jmap.
  • Usa qualquer biblioteca cliente compatível com JMAP — jmap-client (JS), python-jmap, outras.
  • Notificações push via JMAP EventSource — sem polling.
  • IMAP e SMTP também disponíveis para clientes que precisem deles.

API do registo de auditoria

Cada ação de admin, transmissível em streaming.

O mesmo registo de auditoria que lês no painel está disponível como API — paginado, filtrável, com valores antes/depois em cada alteração. Transmite eventos para Splunk, Datadog ou qualquer SIEM que aceite um webhook ou consulte um endpoint paginado. Exporta para CSV ou JSONL para análise forense.

  • Paginado e filtrável: por utilizador, por tipo de evento, por intervalo de datas.
  • Valores antes/depois em cada mutação — rasto forense completo.
  • Transmite para o teu SIEM via webhook ou endpoint pull.
  • Exporta para CSV ou JSONL para análise offline. Sete anos de retenção por defeito.

Pronto para produção

Construído para as integrações duradouras que realmente queres escrever.

Chaves API com âmbito e rotação. Rate limits por chave. Idempotência em escritas. URLs versionadas para que uma deprecação não te apanhe desprevenido num domingo tranquilo. As garantias aborrecidas que tornam uma integração digna de ser escrita.

  • Chaves API com âmbito — read-only, limitadas a uma caixa, limitadas a uma organização.
  • Rotação de chaves no painel — revoga e emite novas sem tempo de inatividade.
  • Versionamento por URL (/api/v1/…) com cabeçalhos de deprecação com meses de antecedência.
  • Changelog OpenAPI publicado; alterações disruptivas apenas em saltos de versão major.

Padrões abertos

RFCs e OpenAPI. Nada proprietário.

Cada protocolo que a API pública fala está documentado publicamente. Traz a tua ferramenta de codegen. Traz a tua biblioteca cliente existente. Nada aqui é inventado para um pitch de fornecedor.

  • 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

Lançamento em julho de 2026

Entrar na lista de espera

Entramos em contacto quando a Verkio abrir.