Skip to main content
Lerian SCR expone una única superficie REST. La institución proviene del token.

​
Superficie de la API

Las operaciones de credencial existen solo cuando un vault de escritura respalda el despliegue. De lo contrario, la credencial proviene del entorno.

​
Autenticación y tenencia

Un consumidor se autentica con un token OAuth2 de client-credentials en Authorization: Bearer. Para cada solicitud protegida, el servicio le pide al servidor de autorización un permiso explícito. Nunca confía en una afirmación no verificada. Un ámbito tiene la forma scr:<resource>:<action>. Consulta Access Manager. La institución proviene de las afirmaciones del token, nunca de un campo del cuerpo, un header, una ruta o un parámetro de consulta. Un despliegue dedicado la fija por instancia. Un token faltante responde SCR-0201, y un ámbito faltante SCR-0202. Un servidor de autorización inalcanzable responde SCR-1002, porque el control falla en modo cerrado.

​
Idempotencia

Las dos operaciones con efectos aceptan un header X-Idempotency. Un reintento dentro de una ventana de cinco minutos repite el primer resultado y no paga una segunda tarifa. Una clave reutilizada con un cuerpo distinto responde SCR-0003. Sin Redis, el control falla en modo abierto, y un reintento vuelve a pagar la tarifa.

​
Errores

Todo fallo responde application/problem+json conforme a RFC 9457, con el código, el estado, y un id de traza.

​
Eventos

Lerian SCR emite un evento por cada consulta terminal a través de un outbox transaccional. La fila de auditoría y el evento hacen commit juntos.
  • studio.lerian.br-scr.consulta.completed: la consulta devolvió una respuesta, una posición o ninguna.
  • studio.lerian.br-scr.consulta.failed: la consulta no devolvió ninguna respuesta.
Ambos tipos viajan por el topic lerian.streaming.br-scr, y los mensajes envenenados por lerian.streaming.br-scr.dlq. Ninguna variable establece el topic, así que aprovisiona ambos. Consulta Streaming Hub. Cuando un operador desactiva la emisión, el despachador no arranca. Las filas permanecen pendientes y se envían en cuanto un broker vuelve a estar disponible.

​
Convenciones de integración

  • Correlación. X-Request-ID lleva un UUID a través de los logs, las trazas, y el registro de auditoría.
  • Fechas de referencia. Los rangos de consulta y los filtros de auditoría usan AAAAMM, un año y mes de seis dígitos. El resumen operativo toma en cambio un rango de fecha y hora.
  • Filtros. El filtro de documento toma de 8 a 14 dígitos, comparados a través del índice ciego. El tipo de cliente 1 es una persona, 2 una empresa.
  • Paginación. El listado de auditoría toma un cursor opaco y un limit de 1 a 200, con valor por defecto 50.
  • Campos codificados. Un campo codificado responde { code, description }, con una descripción nula para un código desconocido.