Pular para o conteúdo principal
Version: 4.41

API DSS

Descrição geral​

A API DSS de Redtrust fornece um serviço de assinatura digital baseado em SOAP que permite criar assinaturas eletrônicas simples e avançadas usando certificados gerenciados de forma centralizada e controles de política.

Esta API é destinada a integradores e desenvolvedores que precisam:

  • Assinar documentos com certificados gerenciados no Redtrust
  • Aplicar políticas de assinatura organizacionais
  • Oferecer suporte a padrões avançados de assinatura (XAdES, CAdES, PAdES)
  • Integrar capacidades de assinatura em sistemas backend ou corporativos

O serviço segue o padrão Digital Signature Service (DSS) da OASIS e algumas extensões selecionadas.

O que você pode fazer com a API DSS​

Em alto nível, a API DSS oferece suporte a três operações, que correspondem aos seguintes métodos do serviço:

  1. GetAccessibleCertificates: Descobrir certificados disponíveis para um usuário ou sistema.
  2. SignHash: Assinar um hash pré-computado (PKCS#1).
  3. SignRequest: Assinar um documento completo usando solicitações compatíveis com DSS.

Como funciona o fluxo de assinatura DSS​

Um fluxo típico de assinatura DSS é o seguinte:

  1. Autenticar-se na API DSS
  2. Obter os certificados acessíveis (opcional, mas recomendado)
  3. Construir uma petição de assinatura (baseada em hash ou em documento)
  4. Enviar a petição para o endpoint DSS
  5. Processar a resposta, que inclui a assinatura ou o documento assinado

A estrutura exata da petição depende de:

  • O tipo de documento (XML, PDF, CMS)
  • O nível de assinatura desejado (BES, EPES, T, LTV etc.)
  • O modo de assinatura (enveloped, enveloping, detached)
  • O perfil de assinatura configurado no Redtrust

Opções de autenticação​

A API DSS oferece suporte a vários mecanismos de autenticação:

  • Usuário e senha (WS-Security UsernameToken)
  • Autenticação por certificado de cliente TLS
  • Autenticação por JSON Web Token (JWT) gerado pelo Redtrust

Cada método de autenticação usa um endpoint diferente. Você encontrará mais detalhes e exemplos na seção de referência de autenticação.

Tipos de documento e padrões de assinatura​

A API DSS oferece suporte aos seguintes padrões de assinatura:

  • XAdES para documentos XML
  • CAdES para conteúdo baseado em CMS
  • PAdES para documentos PDF

Cada padrão oferece suporte a modos e níveis de assinatura específicos, definidos em parte pelo protocolo DSS e em parte pela configuração do perfil de assinatura no Redtrust.

Próximos passos​