Glossário
Os termos usados no termo_core e nesta documentação.
| Termo | Significado |
|---|---|
| termo_core | o SDK da Termotubos, com o mesmo nome no crates.io (Rust) e no npm (TypeScript) |
| Serviço / aplicativo | um sistema da Termotubos com API própria (TermoAuth, TermoBucket...). Vira um módulo do SDK |
| Módulo | termo_core::auth no Rust, termo_core/auth no TypeScript |
| Entidade | o recurso de uma rota (usuario, arquivo), vindo da tag no OpenAPI. Cada entidade é uma página aqui |
| Função de rota | função gerada para uma rota da API, ex.: buscar_pelo_id_usuario |
AMBIENTE | a única variável lida pelo SDK: LOCALHOST, SANDBOX ou PRODUCTION |
| Credencial de acesso | CredencialDeAcesso, o token enviado em Authorization: Bearer |
| Token do usuário logado | o JWT que o TermoAuth deu para a pessoa |
| Segredo do app | segredo gerado no TermoAuth para o app, guardado cifrado no banco do app e entregue com definir_segredo_do_app |
| Token do aplicativo | JWT curto do próprio app, trocado pelo segredo em POST /token_de_app. Para as APIs de sistema |
| Id do aplicativo | o app do token de aplicativo, o mesmo id em todos os serviços (identificador_do_aplicativo()) |
| Contrato | o openapi.json de um serviço ou o catálogo de esquemas de evento, copiado em openapi/ |
| Gerador | o binário gerador que transforma os contratos em código Rust e TypeScript |
| TermoWebhook / hub | o serviço central de eventos |
| Evento | algo que aconteceu num app (colaborador.criado), com tipo e versão |
| Envelope | o evento publicado: id, tipo, versao, entidade_id, ocorrido_em, dados |
| Entrega | o envio de um evento do hub para um app assinante, assinado com Ed25519 |
| Fila de saída | a tabela termo_eventos_pendente no banco do app que publica |
| Versão descontinuada | versão de esquema de evento que ainda circula, mas não deve ser usada em código novo |