📜 Documentação da API ForSign de Assinatura Eletrônica
Introdução
Bem-vindo à documentação da API ForSign! Este guia fornece tudo o que você precisa para integrar a plataforma ForSign de assinatura eletrônica em suas aplicações. Com a ForSign, você pode criar fluxos de trabalho personalizados para a assinatura de documentos, acomodando múltiplos signatários, documentos, campos de formulários e anexos. Cada signatário pode ter uma experiência personalizada conforme suas necessidades.
Primeiros Passos
Para integrar a ForSign na sua aplicação, você precisa entender os conceitos principais e os endpoints. Aqui, forneceremos exemplos práticos para ajudá-lo a iniciar rapidamente.
Resumo básico do fluxo
Fluxo de Operação de Assinatura Eletrônica com a API ForSign: Resumo básico
Importante: nossa API possui endpoints em diferentes versões (1.0 e 2.0). Alguns endpoints ainda não foram migrados e permanecem na versão 1.0 (/api/v1/endpoint), enquanto outros já estão na versão 2.0 (/api/v2/endpoint). Certifique-se de verificar a versão correta de cada endpoint antes de realizar as chamadas.
Como obter sua chave de API (API KEY)
Para utilizar a API ForSign, é necessário obter uma API Key, que servirá como credencial para autenticar suas requisições. Essa chave garante segurança e controle sobre o acesso à API.
Passos para obter sua chave de API:
- Acesse o painel da ForSign e faça login com sua conta.
- Navegue até a seção Desenvolvedor e localize a opção Chave de API.
- Gere uma nova chave e copie o valor gerado.
- Utilize a chave em suas requisições, incluindo-a no cabeçalho X-Api-Key.
Lembre-se de armazenar sua API Key com segurança e nunca compartilhá-la publicamente.
Documentação completa aqui 👇
Criar e gerenciar operação
Upload de documento
O endpoint de upload de documento permite enviar arquivos para a plataforma ForSign, sendo o primeiro passo para criar uma operação de assinatura eletrônica. Este endpoint aceita documentos em formato PDF e suporta o envio de único de arquivo por requisição.
Principais características do endpoint:
- Aceita documento em formato PDF (max: 10mb)
- Retorna identificador único para o documento enviado
- Realiza validações de formato e integridade do arquivo
Após o upload bem-sucedido, o documento fica disponível para ser vinculado a uma operação de assinatura, onde serão definidos os signatários e demais parâmetros do fluxo.
Documentação aqui 👇
Criar a operação
O endpoint de criar operação é fundamental para iniciar um fluxo de assinatura eletrônica. Este endpoint permite configurar todos os aspectos da operação de assinatura, incluindo:
- Definição dos documentos que serão assinados
- Configuração dos signatários e suas respectivas funções
- Estabelecimento da ordem de assinatura (quando aplicável)
- Definição de campos de formulário e posicionamento de assinaturas
- Configuração de notificações e prazos
Após a criação bem-sucedida da operação, o sistema retorna um identificador único que pode ser usado para acompanhar e gerenciar todo o processo de assinatura.
Este é o endpoint mais completo e dinâmico contendo a maioria da opções de customização do fluxo, separe um tempo para analisar todas as possibilidades, com certeza a sua regra de negócio é atendida aqui.
Documentação aqui 👇
Download de todos os arquivos
O endpoint de download de todos os arquivos permite recuperar todos os documentos associados a uma operação de assinatura eletrônica. Este recurso é útil para obter uma cópia completa de todos os documentos após a conclusão do processo de assinatura.
Características principais do endpoint:
- Retorna todos os documentos vinculados à operação em um único arquivo ZIP
- Permite download seguro com autenticação
Este endpoint é especialmente útil para arquivamento e backup dos documentos assinados, garantindo que você tenha acesso a todas as versões dos documentos em um único local.
Documentação aqui 👇
Endpoint para Download de todos os arquivos
Cancelar ou Completar uma operação
A API ForSign oferece endpoints específicos para gerenciar o ciclo de vida de uma operação, permitindo que você cancele uma operação em andamento ou a marque como concluída manualmente. Estes endpoints são especialmente úteis para situações onde é necessário interromper um processo de assinatura ou finalizar uma operação que atingiu seus objetivos. O controle granular sobre o estado da operação permite uma gestão eficiente do fluxo de assinaturas, garantindo que as operações sejam adequadamente encerradas ou canceladas conforme as necessidades do negócio.
Documentação aqui 👇
Endpoint de Conclusão de Operação
Endpoint de Cancelamento de Operação
Alterar tipo de finalização
A API ForSign permite alterar o tipo de finalização de uma operação entre automática e manual. Na finalização automática, a operação é concluída assim que todos os signatários completam suas ações. Já na finalização manual, é necessária uma ação explícita através da API para marcar a operação como concluída ou quando o prazo final é atingido, oferecendo maior controle sobre o processo de fechamento.
Documentação aqui 👇
Endpoint de mudança para conclusão manual
Endpoint de mudança para conclusão automática
Gerenciamento de anexos
A API ForSign oferece um conjunto robusto de endpoints para gerenciar anexos em operações de assinatura eletrônica. Os anexos são documentos complementares que podem ser solicitados aos signatários durante o processo, como documentos de identificação ou comprovantes. Este sistema permite um controle completo sobre o ciclo de vida dos anexos, desde o upload até a aprovação ou rejeição.
Listar anexos por membro
Este endpoint permite listar todos os anexos enviados por um determinado membro da operação. Através dele, é possível visualizar o status de cada anexo. Esta funcionalidade é especialmente útil para acompanhar o progresso dos documentos complementares necessários em uma operação.
Documentação aqui 👇
Endpoint de Obtenção de Anexos por ID de Membro
Aprovar anexos
O endpoint de aprovação de anexos permite validar os documentos complementares enviados pelos signatários. Esta funcionalidade é essencial para garantir que todos os anexos necessários atendam aos requisitos estabelecidos. Uma vez aprovados, os anexos são vinculados permanentemente à operação e podem ser acessados quando necessário.
Documentação aqui 👇
Rejeitar anexos
O endpoint de rejeição de anexos permite que administradores ou responsáveis pela operação recusem documentos complementares que não atendam aos critérios estabelecidos. Quando um anexo é rejeitado, o signatário é notificado e pode realizar um novo envio. Este processo garante a qualidade e conformidade dos documentos anexados à operação.
Documentação aqui 👇
Download dos anexos
O endpoint de download de anexos permite recuperar os documentos complementares enviados pelos signatários durante o processo de assinatura. Este endpoint oferece acesso seguro aos anexos individuais, permitindo que administradores e partes autorizadas baixem e verifiquem os documentos conforme necessário. A funcionalidade é especialmente útil para fins de auditoria e conformidade, garantindo que todos os documentos complementares permaneçam acessíveis após a conclusão da operação.
Documentação aqui 👇
Opções adicionais
Assinaturas por TAG
A funcionalidade de Assinaturas por TAG permite definir pontos específicos dentro do documento onde cada signatário deve assinar, utilizando identificadores pré-configurados. Dessa forma, o posicionamento da assinatura é feito automaticamente com base nas tags inseridas no próprio documento, eliminando a necessidade de definir coordenadas manualmente.
Principais vantagens:
- Automação: Define automaticamente os locais de assinatura com base em tags dentro do documento.
- Flexibilidade: Permite múltiplos signatários com assinaturas em posições distintas.
- Facilidade de uso: O documento pode ser preparado previamente com as tags apropriadas, garantindo um fluxo mais ágil.
Cada tag deve seguir um padrão específico definido na documentação da API para garantir o correto reconhecimento pela plataforma.
Documentação completa aqui 👇
Webhooks
Os Webhooks são uma maneira eficiente de receber notificações automáticas sobre eventos relevantes dentro da API ForSign. Com eles, sua aplicação pode reagir em tempo real às mudanças no status de uma operação de assinatura, sem a necessidade de realizar requisições constantes à API.
Principais características:
- Notificações em tempo real: Receba atualizações instantâneas sempre que uma etapa do processo de assinatura for concluída.
- Eventos configuráveis: Escolha quais eventos deseja acompanhar, como criação de operação, conclusão de assinatura, rejeição de documentos, entre outros.
- Facilidade de integração: Basta fornecer uma URL de callback para onde as notificações serão enviadas.
Os webhooks garantem maior eficiência e controle sobre o fluxo de assinaturas, permitindo automação e respostas ágeis às mudanças no processo.
Documentação completa aqui 👇
Experiência do Usuário fluída com a URL Redirect
A funcionalidade de URL Redirect permite redirecionar automaticamente os usuários para uma página personalizada após a conclusão de uma assinatura eletrônica. Essa funcionalidade melhora a experiência do usuário, tornando a navegação mais fluida e profissional.
Principais vantagens:
- Personalização avançada: Defina URLs dinâmicas com base nos dados da operação.
- Fácil integração: Configuração simples via API.
- Automação do fluxo: Permite direcionar os usuários para páginas de confirmação ou acompanhamento.
A configuração é feita via API, utilizando o metadado @module/redirect-url. A URL pode conter parâmetros dinâmicos, como externalId e operationId, permitindo personalização total conforme a necessidade do cliente.
Documentação completa aqui 👇
Ajude-nos a melhorar nossa documentação!
Sua opinião é muito importante para nós! Queremos garantir que nossa documentação seja clara, completa e fácil de usar. Responda à nossa pesquisa e nos ajude a aprimorar continuamente a experiência de desenvolvimento com nossa API.