/v1. Toda rota de negócio exige um bearer token.
Superfície da API
Endpoints de operador ficam fora de
/v1.
Autenticação e tenancy
Toda rota
/v1 recebe um bearer token OAuth2 do Lerian Access Manager. Com PLUGIN_AUTH_ENABLED=true e PLUGIN_AUTH_HOST, o Lerian Access Manager autoriza cada requisição. Só um ENV_NAME de desenvolvimento fora de saas aceita false.
Cada instituição mantém seu próprio schema de banco de dados.
Idempotência
O Lerian CCS aceita um header
X-Idempotency opcional na maioria das rotas que alteram estado. Um middleware armazena em cache a primeira resposta e a repete para uma repetição da mesma chave. Uma repetição com outro corpo responde 422, e uma repetição enquanto a primeira requisição executa responde 409. As chaves pertencem a uma instituição, e a retenção padrão é de 7 dias.
Erros
Um erro de negócio responde com um documento de problema RFC 9457, com o tipo de mídia
application/problem+json e um código de produto. Os valores de código são um contrato congelado, então um cliente compara pelo código, não pelo texto da mensagem.
Eventos
O Lerian CCS publica um evento de negócio em seu próprio tópico, com um tópico dead-letter correspondente. O tópico e o tipo de evento seguem a regra de nomenclatura do Streaming Hub, com a fonte CloudEvents deste serviço como namespace.
Ele carrega a postura de entrega crítica. O serviço o grava no outbox transacional, na mesma transação da mudança de estado. O streaming vem desativado por padrão. Enquanto estiver desativado, o serviço conecta um emissor no-operation e não publica nada. O Lerian Streaming Hub é a camada de entrega.
Com
RABBITMQ_ENABLED=true, o Lerian CCS também publica notificações no exchange definido por RABBITMQ_EXCHANGE.
Os documentos nesses payloads são mascarados.
Convenções de integração
- Headers. Enquanto
CORS_ALLOWED_HEADERSpermanecer sem definição, vale uma lista padrão fixa, e ela não incluiX-Idempotency. Um valor que você define substitui essa lista, então informe cada header que seu cliente de navegador envia. - Paginação. Cada rota de listagem limita seu próprio tamanho de página. Um tamanho de página de 100 ou menos fica dentro do limite de cada rota.
- Rate limits. O limitador cobre apenas
/v1. Requisições que alteram estado e leituras pesadas, como consultas de auditoria, têm níveis mais restritos. - Referências de arquivo. O XML regulatório permanece no armazenamento de objetos. A API e as mensagens do broker carregam apenas referências de arquivo.