Configuração
2 funções do TermoSell para configuração.
// npm install termo_core --save-exact
import * as sell from "termo_core/sell";
// ou: import { sell } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_pelo_id_configuracao | GET /configuracao | Mostra a configuração do app (segredo do TermoAuth) |
atualizar_pelo_id_configuracao | PATCH /configuracao | Grava o segredo do app gerado no TermoAuth |
buscar_pelo_id_configuracao
GET/configuracao Exige credencial
Mostra a configuração do app (segredo do TermoAuth)
Só um master do TermoAuth. O segredo do app gerado no TermoAuth nunca volta: a resposta traz só configurado e os últimos caracteres mascarados em final_visivel. criptografia_disponivel é falso quando o servidor está sem a GLOBAL_SECRET_CRIPTOGRAFIA; nesse caso nada pode ser lido nem gravado. atualizado_em é nulo enquanto ninguém gravou a configuração.
function buscar_pelo_id_configuracao(
credencial_de_acesso: CredencialDeAcesso,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_configuracao } from "termo_core/sell";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_configuracao(credencial_de_acesso);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.
atualizar_pelo_id_configuracao
PATCH/configuracao Exige credencial
Grava o segredo do app gerado no TermoAuth
Só um master do TermoAuth. Campo ausente fica como está, texto troca e null limpa. O segredo é gravado cifrado (AES-256-GCM com a GLOBAL_SECRET_CRIPTOGRAFIA) e entregue na hora ao termo_core, sem deploy. Até 2.000 caracteres, sem quebra de linha.
function atualizar_pelo_id_configuracao(
credencial_de_acesso: CredencialDeAcesso,
corpo_da_requisicao: tipos.ConfiguracaoAtualizar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_configuracao } from "termo_core/sell";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_configuracao(credencial_de_acesso, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
Configuracao
import type { Configuracao } from "termo_core/sell";
export interface Configuracao {
atualizado_em?: string | null;
atualizado_por?: string | null;
criptografia_disponivel: boolean;
segredo_do_app_gerado_no_termo_auth: ValorProtegido;
}ConfiguracaoAtualizar
import type { ConfiguracaoAtualizar } from "termo_core/sell";
export interface ConfiguracaoAtualizar {
segredo_do_app_gerado_no_termo_auth?: string | null;
}ValorProtegido
import type { ValorProtegido } from "termo_core/sell";
export interface ValorProtegido {
configurado: boolean;
final_visivel?: string | null;
}