Configuração
2 funções do TermoWebhook para configuração.
// npm install termo_core --save-exact
import * as webhook from "termo_core/webhook";
// ou: import { webhook } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_pelo_id_configuracao | GET /configuracao | Mostra se o segredo do app está cadastrado |
atualizar_pelo_id_configuracao | PATCH /configuracao | Grava ou limpa o segredo do app |
buscar_pelo_id_configuracao
GET/configuracao Exige credencial
Mostra se o segredo do app está cadastrado
Só o master do TermoAuth (os demais recebem 403). Devolve a configuração única do TermoWebhook (tela /painel/configuracoes/provedores). O segredo do app gerado no TermoAuth nunca volta aberto: só configurado e o final mascarado (final_visivel). Fica cifrado no banco com AES-256-GCM e a chave derivada de GLOBAL_SECRET_CRIPTOGRAFIA; sem essa variável no servidor, ou se ela mudou, configurado vem false.
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/webhook";
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 ou limpa o segredo do app
Só o master do TermoAuth (os demais recebem 403). segredo_do_app_gerado_no_termo_auth ausente fica como está, string troca (até 2.000 caracteres, sem quebra de linha; vazia conta como limpar) e null limpa. O valor é cifrado com a GLOBAL_SECRET_CRIPTOGRAFIA e entregue na hora ao termo_core, sem deploy. A resposta é a mesma do GET.
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/webhook";
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/webhook";
export interface Configuracao {
atualizado_em: string;
atualizado_por?: string | null;
segredo_do_app_gerado_no_termo_auth: ValorProtegido;
}ConfiguracaoAtualizar
import type { ConfiguracaoAtualizar } from "termo_core/webhook";
export interface ConfiguracaoAtualizar {
segredo_do_app_gerado_no_termo_auth?: string | null;
}ValorProtegido
import type { ValorProtegido } from "termo_core/webhook";
export interface ValorProtegido {
configurado: boolean;
final_visivel?: string | null;
}