IdeiaSigner
  1. Signer
IdeiaSigner
  • Bem-vindo
  • Política de Privacidade
  • API Auxiliar
    • Manual de Integração APIs
    • Endpoints
      • CadastrarOrganizacao
      • AtualizarDadosFaturamento
      • CadastrarUsuario
  • Certificação Digital
    • O que é?
    • Assinaturas Digitais
    • Assinaturas de servidor
    • Login com certificado digital
    • Certificados confiados pela Adobe
    • Assinaturas web
      • O que são?
      • Assinaturas web remotas
      • Assinaturas web locais
  • Web PKI
    • O que é?
    • Primeiros passos
    • Propriedades dos certificados
    • Personalizando a listagem de certificados
    • Pré-validação de certificados
    • Browsers suportados
    • Instalação e distribuição de componentes do WEB PKI via GPO
    • Licenciamento
    • Chamadas assíncronas
    • Callback de erro padrão
    • Customizando o comportamento quando o componente não estiver instalado
    • Utilizando uma página de instalação personalizada
    • Callbacks e AngularJS
    • Filtros de certificados
    • Especificando a URL do Rest PKI
    • Atualizações - Web PKI
    • Requisição Autenticada
    • Logs - Web PKI
    • Atributos de Segurança - Web PKI
    • Substituição do ICPBravoAccess
    • FAQ
      • Qual é a diferença entre as funções signData e signHash?
      • Qual é o formato da assinatura retornada pelas funções signData e signHash?
      • O Web PKI suporta conexões SSL usando o certificado do usuário?
  • Rest PKI
    • O que é?
    • Rest PKI - Disponibilidade de exemplos por projeto
    • Códigos de Retorno do REST PKI
    • Tags da representação visual de assinaturas PAdES
    • Configuração de Data e Hora
    • Solicitando carimbos de tempo
  • Signer
    • Guia de Integração
    • Integração com Assinatura embutida
    • Guia do usuário
      • Geração de documentos
    • Administração do sistema
      • Adicionando usuário à administração
      • Visualizando os documentos
      • Excluindo documentos
    • Sobre o Signer
      • Histórico de versões do Signer
      • Código de erro inesperado ao submeter ou assinar um PDF
  • GrantID
    • GrantID - Inicio
  1. Signer

Guia de Integração

Introdução#

O Signer é um portal de documentos que permite a realização de assinaturas digitais e eletrônicas bem como a criação de fluxos complexos. Este documento discute as possíveis opções de integração para que sua aplicação possa aproveitar ao máximo o potencial do Signer.

Autenticação#

Todas as chamadas de API exigem uma chave de acesso de API (API Key). Essa chave deve ser colocada no cabeçalho de todas requisições:
Toda chave de API está associada uma Organização previamente cadastrada no Signer. Sendo assim, o escopo dessa chave fica restrito àquela organização, isto é, aquela chave só permitirá acessar/criar documentos daquela organização.
Para obter uma chave de API entre em contato com o administrador da sua instância.

Opções de integração#

Escolha um dos casos de uso abaixo:
Assinar um documento
Como posicionar uma assinatura
Verificar o status de um documento
Enviar lembretes de assinatura
Download das versões de um documento
Listar documentos
Validar assinaturas de um documento
Deletar um documento

Assinar um documento#

Para assinar um documento siga o passo a passo abaixo:
1- Faça o upload do arquivo a ser assinado usando a API de Upload (POST /api/uploads).
O arquivo deve ser enviado com uma requisição multipart/form-data. Será retornado um ID de upload que identifica aquele arquivo:
Alternativamente pode ser utilizada a API simplificada de Upload (POST /api/uploads/bytes),
na qual os bytes podem ser enviados em formato Base64.
2- Crie um documento à partir do upload usando a API de Criação de Documentos.
Nessa chamada você deve montar o fluxo do documento, isto é, definir quais serão os participantes do documento e em qual ordem devem tomar suas ações:
Você pode criar mais de um documento na mesma chamada de criação, adicionando quantos arquivos forem necessários. Nesse caso, todos documentos terão o mesmo fluxo.
A resposta retornará o ID do documento criado associado ao ID do upload, assim você sabe exatamente qual documento corresponde a qual upload:
Ao criar o documento, o Signer automaticamente notifica os participantes adicionados no fluxo seguindo a ordem especificada.
Cada participante receberá um e-mail com um link que permitirá a assinatura/aprovação do documento.
Não é preciso se autenticar para assinar ou aprovar o documento.

Assinatura em sua própria aplicação#

Caso você queira realizar a assinatura do documento em sua própria aplicação, você pode usar a opção de Assinatura Embutida.
Para isso, você deve seguir os mesmos passos exibidos na seção anterior, no entanto, ao enviar o documento, recomenda-se adicionar o parâmetro disablePendingActionNotifications com valor true. Dessa forma, não serão enviadas notificações para os participantes.
Após a criação do documento, utilize o ID do documento para obter a URL de Assinatura usando a API de URL de Ação:
Caso o signatário tenha permitido assinatura eletrônica (usando o parâmetro allowElectronicSignature = true no upload do documento), é possível exigir que ocorra a confirmação do e-mail dele por meio de um código de acesso no momento da assinatura. Para isso, deve ser definido requireEmailAuthentication como mostrado abaixo:
A resposta irá apresentar duas URLs:
Uma vez obtida a URL embedUrl, utilize o Widget de assinatura para exibir a página de assinatura do Signer na sua aplicação.
A página Assinatura embutida descreve como utilizar o Widget.

Como pré-posicionar uma assinatura no documento#

Durante a criação de um documento, é possível posicionar as assinaturas de cada usuário em um determinado local deste mesmo documento. Todas as definições de atributos são feitas durante a criação do flowAction. Há opções para definir a localização da assinatura em uma página, bem como a pagina na qual deseja pré-posicionar uma assinatura.

Verificar o status de um documento#

Para verificar o status de um documento é preciso conhecer o seu ID. Em seguida, basta fazer uma chamada à API de Detalhes do Documento:
Para saber se o documento está concluído, verifique a propriedade status corresponde a Concluded.
Para saber se um participante assinou/aprovou, verifique se a propriedade status corresponde a Completed para o elemento da lista de
ações (flowActions) que corresponde a ele.
Adicionalmente, você pode configurar um Webhook que será disparado toda vez que um documento de sua organização for concluído, aprovado, recusado ou assinado. Para isso,
acesse a tela da Organização e registre a URL desejada na opção Integração:
image.png

Enviar lembretes de assinatura#

Uma vez verificado o status de um participante, conforme mostrado no caso de uso de Verificação de status, você pode enviar lembretes periódicos para participantes do fluxo que ainda não completaram uma ação usando a API de Envio de Lembretes.
Para isso, informe o ID do documento e o ID da ação do participante (flowActionId):

Download das versões de um documento#

A partir do momento que um documento foi criado, é possível fazer o download de diferentes tipos de versões deste mesmo documento (de acordo com o estágio no qual ele se encontra). Caso queira fazer o download do documento, utilize a API de Download de Documentos.
As opções disponíveis para download são:
Arquivo Assinado
Versão para impressão
Etiquetas de assinatura
Marcas de Assinatura
Arquivo Original
Existem dois métodos com seus respectivos tipos de retorno de dados: O primeiro retornará uma Stream de dados referente ao documento e o segundo retornará o documento em um vetor de bytes[].

Listar documentos#

É possível listar os documentos de acordo com padrões e necessidades diferentes. O parametros utilizados estão listados na API de Listagem de Documentos. Os tipos de listas que podem ser retornadas estão identificados abaixo:
Documentos pendentes para um determinado participante
Documentos concluídos
Listar por pastas
Listar por organização

Validar assinaturas de um documento#

Você pode validar as assinaturas de um documento de duas formas: com a chave de validação do documento (caso ele tenha sido assinado nesta instância do Signer) ou com o arquivo
assinado.

Validação de documento com chave de validação#

Para validar um documento com chave de validação, use a API de Validação de Chave informando a chave correspondente.
Serão retornados os dados básicos do documento e as informações de cada uma das assinaturas encontradas naquele documento:

Validação de documento com arquivo assinado#

Para validar um documento assinado é preciso fazer primeiro o upload do arquivo assinado usando a API de Upload ou [API simplificada de Upload (POST /api/uploads/bytes)] https://app.ideiasigner.com.br/swagger/index.html#operations-Upload-post_api_uploads_bytes)
assim como informado na seção Assinar um Documento.
Em seguida, utilize a API de validação de arquivo assinado.
Serão retornados os dados de cada uma das assinaturas encontradas no documento.

Deletar documento#

Para deletar um documento você precisa ter acesso ao ID deste mesmo documento e fazer um chamada do tipo DELETE.

Cancelar documento#

Caso queira cancelar um documento, é necessário enviar o ID do documento através de uma requisição do tipo POST junto ao campo reason, conforme o exemplo abaixo:

Recusar documento#

Para recusar um documento, é necessário enviar o ID do documento através de uma requisição do tipo POST junto ao campo reason, conforme o exemplo abaixo:

Enviar nova versão documento#

É possível enviar uma nova versão do documento para um documento já criado. Portanto, é necessário enviar o ID do documento, através de uma requisição do tipo POST, junto ao arquivo relativo a nova versão. Vale ressaltar que o fluxo de assinaturas será reiniciado.

Mesclar múltiplos arquivos em um único documento#

É possível fazer o upload de múltiplos arquivos e mesclar todos em um só documento (envelope). Para fazer isso, é necessário a adição do parâmetro isEnvelope=true e um nome de envelope EnvelopeName. É importante ressaltar que a mesclagem só funcionará se todos os arquivos enviados forem PDFs.
Modificado em 2024-12-03 17:30:46
Página anterior
Solicitando carimbos de tempo
Próxima página
Integração com Assinatura embutida
Built with