A ForSign mantém SDKs oficiais para C# (.NET) e PHP. Eles fazem as chamadas à API por você: autenticação com a chave, envio do PDF, criação da operação, anexos, conclusão, cancelamento e download.
Quando usar
- O seu sistema é em .NET ou PHP e você quer integrar sem montar as requisições HTTP na mão.
- Você quer validar o pedido antes de enviar, como posições de assinatura e tipos de assinatura.
- O seu sistema roda em .NET Framework antigo e precisa de uma biblioteca compatível.
Para outras linguagens, use a API direto. A documentação em docs.forsign.digital tem exemplos de chamada.
C# (.NET)
Instale o pacote ForSign.Sdk pelo NuGet:
dotnet add package ForSign.Sdk
Crie o cliente e informe a chave:
var client = new ForSignClient();
client.SetCredential(new ApiKeyCredential("SUA_CHAVE"));
Funciona do .NET Framework 4.5 ao .NET 8, além de .NET Standard 2.0 e .NET Core 3.0. A única dependência é o Newtonsoft.Json.
PHP
Instale pelo Composer:
composer require forsign/api-php
$client = new ForSign\Api\Client(getenv('FORSIGN_API_KEY'));
Exige PHP 8.1 ou mais novo. O cliente aceita endereço base, tempo limite e número de novas tentativas, e um logger PSR-3 opcional.
O que os SDKs cobrem
| Ação | C# | PHP |
|---|---|---|
| Subir o PDF | Sim | Sim |
| Criar a operação | Sim | Sim |
| Concluir e cancelar | Sim | Sim |
| Listar, aprovar, recusar e baixar anexos | Sim | Sim |
| Baixar o ZIP com os PDFs assinados e o dossiê | Sim | Sim |
Os SDKs cobrem a API pública. Webhooks, modelos, usuários e relatórios ficam fora. O webhook você recebe no seu próprio servidor. Veja Eventos do webhook e novas tentativas.
Créditos
O SDK não consome crédito. A operação criada por ele consome igual a qualquer operação.
Perguntas comuns
Qual chave o SDK usa? A mesma chave de API do Painel do desenvolvedor. Veja Onde pegar a chave de API.
Tem SDK para Java, Python ou Node.js?
Hoje os SDKs mantidos são C# e PHP. Para outras linguagens, chame a API direto pelo cabeçalho X-Api-Key.
Onde vejo exemplos completos? Na seção de SDKs de docs.forsign.digital. O pacote PHP também traz exemplos de criar operação, gerenciar anexos, cancelar e baixar o ZIP.