JL
ES
Inicio de documentación
Menú
Guías

Mapa De Flujo Del Cliente

Define la secuencia principal esperada para clientes que integran con jsonlog.

guide jsonlog

Mapa De Flujo Del Cliente

Objetivo: definir la secuencia de alto nivel esperada para clientes que integran con jsonlog.

Flujos Principales

  1. Inicializar auth contra auth.jsonlog.com y obtener un token Bearer para rutas aisladas por cuenta.
  2. Enviar logs por POST /log (público o por canal) con cuerpo JSON.
  3. Recibir logs en tiempo real por upgrade GET /ws con filtros opcionales cid y level.
  4. Aplicar acceso a canales privados por claim de cuenta (acc) en lecturas/escrituras HTTP y WebSocket.
  5. Descubrir archivos SSTable durables con POST /query e inspeccionar agregados con GET /query/stats.
  6. Monitorear disponibilidad del servicio y estado de escritura con GET /health y GET /stats.

Familias De Endpoints

  • Ingesta:
    • POST /log
    • GET /log
  • Streaming:
    • GET /ws (endpoint de upgrade WebSocket)
  • Consultas:
    • POST /query
    • GET /query/stats
  • Servicio:
    • GET /health
    • GET /stats
  • Documentación:
    • GET /openapi.json
    • GET /docs
    • GET /swagger

Expectativas De Seguridad

  • La verificación de firma JWT usa por defecto https://auth.jsonlog.com/.well-known/jwks.json?client_id=cid_jsonlog.
  • Las rutas /query requieren auth Bearer y usan acc del JWT para aislamiento por cuenta.
  • El acceso a canales privados requiere que acc del JWT coincida con la cuenta propietaria del canal.
  • Las lecturas no autorizadas de canales privados devuelven 404 para evitar descubrimiento de canales.
  • El uso sin auth es solo para desarrollo local y no debe ser la opción por defecto en producción.