API e desenvolvedores

Suba o PDF, crie a operação, receba o webhook.

Seu sistema cria o contrato, manda assinar e recebe o PDF pronto de volta, sem ninguém abrir o app da ForSign. Com SDK em C# e PHP.

Acesso por chave de API, revogável na hora.

Você gera e troca a chave no Painel do desenvolvedor. Se ela vazar ou alguém sair do time, a troca derruba o acesso antigo na hora, sem abrir chamado.

Como autenticar, na documentação

Criar a operação com participantes e assinatura por tag.

Uma chamada cria a operação inteira: documentos, participantes, ordem de assinatura, formulário, anexos e prazo. Se alguma validação falhar, nada é gravado e nenhum crédito é debitado.

Para contratos que mudam a cada geração, marque o PDF com uma tag e a ForSign posiciona a assinatura em todas as ocorrências, sem coordenada fixa.

O seu identificador acompanha a operação até o webhook, e amarra a assinatura ao pedido de origem.

Todos os campos de criar operação Como as tags funcionam

Receber os eventos em vez de perguntar.

Cadastre a URL no Painel do desenvolvedor e pare de consultar a API atrás de novidade. Cada entrega vai assinada, para você confirmar a origem.

Baixe o resultado quando chegar o DocumentReady: é ele que avisa que os PDFs finais estão prontos.

Todos os eventos, na documentação

Os eventos que disparam

  • UpdateOperationA operação mudou: status, participante ou anexo.
  • DocumentSignedUm participante assinou.
  • CompletedOperationTodos assinaram.
  • DocumentReadyOs PDFs finais estão prontos. É aqui que se baixa.
  • AttachmentFilledUm participante enviou um anexo solicitado.
  • FormFilledO formulário foi preenchido antes da assinatura.
  • SelfieCapturedA selfie do antifraude foi enviada.

Quando sua URL falha

A ForSign tenta entregar de novo automaticamente. Se a URL continuar fora do ar, o webhook é suspenso e avisamos por e-mail quem cuida das integrações. Depois de corrigir, é só reativar.

Todas as entregas ficam nos logs, e qualquer uma pode ser reenviada com um clique.

SDKs oficiais em C# e PHP.

Os dois cobrem o ciclo inteiro: subir o PDF, criar, finalizar, cancelar e baixar o ZIP assinado. Eles validam os dados antes de chamar a API, então o erro aparece no seu código e não na operação do cliente.

Referência dos SDKs

Integração pronta para SAP.

Se o documento já nasce no SAP, ninguém precisa escrever integração do zero.

SAP S/4HANA, ECC e SuccessFactors

Kit pronto para o SAP Integration Suite: o documento nasce no SAP, vai para assinatura e volta assinado para o ArchiveLink ou o GOS.

Cobre contrato de compra e venda, aditivo, documento de RH e admissão pelo SuccessFactors.

Guia do kit SAP

Um ambiente de testes com marca d'água.

Teste a integração sem gastar crédito de produção. Tudo o que sai do sandbox leva marca d'água e não tem validade jurídica.

Para ter o sandbox, peça ao suporte ou ao especialista da sua implantação.

Perguntas frequentes

Preciso de qual plano para usar a API?
A API faz parte dos planos contratados com a ForSign, e a operação criada por ela consome os mesmos créditos de uma operação criada no app. Como funciona a API, na central de ajuda.
Onde cadastro os webhooks?
No Painel do desenvolvedor, com um webhook para cada tipo de evento. Cada entrega fica registrada no log e pode ser reenviada.
Como consigo o sandbox?
Peça ao suporte ou ao especialista da implantação: a ForSign converte uma conta de testes em sandbox.

Monte a operação com um especialista.

Conte quais documentos você assina, quem assina e o que a contraparte exige. A gente indica o tipo de assinatura, a ordem e o antifraude que fazem sentido.