Pular para o conteúdo principal

UbID Trust API

O UbID Trust API é o domínio de produto voltado a desenvolvedores para integrar capacidades de identidade e confiança em aplicações institucionais. Ele fornece contratos governados para solicitar, validar e coordenar operações de proofing, credenciais, apresentações, status, acesso, recuperação e metadados de confiança.

A API não é uma janela direta para bancos de dados internos nem chaves criptográficas. É um limite controlado que traduz a intenção de protocolos externos em operações de domínio validadas.

Filosofia de integração​

Uma API de confiança duradoura deve permanecer estável mesmo quando tecnologias internas mudam. Por isso, o UbID enfatiza:

  • contratos baseados em papéis, em vez de exposição de serviços internos;
  • esquemas e validação explícitos;
  • comportamento versionado;
  • autorização e finalidade claras;
  • operações idempotentes quando prático;
  • identificadores rastreáveis de solicitação e decisão;
  • semântica consistente de erros;
  • separação entre preparação, validação, aprovação e execução.

Padrões comuns de integração​

Parceiros autorizados podem integrar-se em torno de padrões como:

  • descobrir capacidades suportadas de credencial ou verificação;
  • preparar uma solicitação de emissão;
  • validar dados contra uma definição aprovada de credencial;
  • iniciar um fluxo de entrega ao titular;
  • solicitar uma apresentação de credencial;
  • enviar evidências para proofing ou verificação;
  • consultar metadados públicos de emissor, chaves, status ou protocolo;
  • coordenar a preparação de recuperação sob política;
  • recuperar um resultado autorizado de operação ou referência de evidência.

O conjunto exato de operações depende do papel do parceiro, do escopo da implantação e do estado de disponibilidade.

Preparar, validar, aprovar e executar​

Operações sensíveis de identidade não devem ser expostas como um único comando irrestrito. O padrão preferido é:

  1. Preparar — reunir a operação pretendida e os dados necessários.
  2. Validar — verificar esquema, identidade, política, confiança e condições técnicas.
  3. Aprovar — obter a autorização humana ou de política necessária.
  4. Executar — realizar a alteração autoritativa de estado ou a operação criptográfica.

Esse padrão reduz execução acidental e oferece às instituições um ponto claro para aplicar segregação de funções e requisitos de evidência.

Filosofia de erros​

Uma API de identidade deve falhar com clareza. Erros úteis devem distinguir, sem expor detalhes internos sensíveis:

  • entrada inválida ou incompleta;
  • papel ou escopo não autorizado;
  • credencial ou protocolo não suportado;
  • falha na validação de confiança ou política;
  • estado de transação vencido ou consumido;
  • dependência indisponível;
  • operação pendente de revisão;
  • conflito com o estado atual do ciclo de vida.

Respostas de erro devem ajudar um integrador autorizado a corrigir uma solicitação, evitando divulgar regras contra abuso, topologia de infraestrutura ou dados de outros usuários.

Metadados de confiança e descoberta​

Algumas informações são deliberadamente públicas ou descobríveis por parceiros, como padrões suportados, identificadores de emissores, chaves públicas de verificação, metadados de tipos de credencial e capacidades de serviço.

Dados de descoberta devem permanecer curados. Publicar uma capacidade não concede autorização para invocá-la, e chaves públicas nunca devem ser acompanhadas de material privado.

Relação com outros produtos​

O UbID Trust API fornece um limite de integração para todo o portfólio:

  • UbID Proof para interações de evidência e assurance;
  • UbID Credential Cloud para o ciclo de vida de emissão;
  • UbID Wallet para entrega ao titular e apresentação;
  • UbID Connect para padrões e mensagens confiáveis;
  • UbID Recover para coordenação protegida de recuperação;
  • UbID KeyVault por serviços criptográficos de escopo restrito;
  • UbID Pulse para consultas autorizadas de postura e evidência.

O que este produto não fornece publicamente​

A documentação pública não fornece acesso produtivo irrestrito, esquemas completos de clientes, credenciais de tenants, políticas privadas de rate limit, mapas internos de serviços nem operações administrativas de alto impacto.

Especificações detalhadas de API são fornecidas por onboarding controlado de parceiros quando o papel pretendido, o ambiente, a finalidade e as responsabilidades de segurança forem aprovados.

Consulte também Desenvolver com o UbID, Modelo de integração e Onboarding de parceiros.