SDKs e ferramentas

Assinatura eletrônica com SDK oficial na linguagem do seu backend

Q: Quais linguagens têm SDK oficial?

SDKs de servidor para TypeScript, Python, Ruby, Go, Rust, .NET, PHP e Java, publicados no registry de cada linguagem. O Object Pascal é distribuído pelo repositório no GitHub, testado com Free Pascal 3.2.2 no Linux e no macOS. Com Delphi 12+ no Windows, o uso ainda é experimental. Para apps, há clientes nativos iOS e Android.

Q: Preciso de um SDK para usar a API?

Não. A API é REST e funciona em qualquer linguagem que fale HTTP. Os SDKs são uma opção para quem prefere a convenção da própria linguagem.

Q: Onde instalo o SDK de Java?

No Maven Central, com Maven ou Gradle, como os outros SDKs de servidor, que saem no registry de cada linguagem.

Q: Qual SDK uso no app de celular?

Os de iOS e Android. A chave de API fica só no seu servidor.

Q: Como passo do sandbox para a produção?

Use a URL base e a chave de produção. A URL de produção é api.assinafy.com.br/v1.

Q: Os SDKs são de código aberto?

Sim. Os SDKs estão no GitHub, com licença MIT e exemplos de uso em cada repositório.

Q: Dá para enviar o documento e pedir a assinatura numa chamada só?

Dá, com o atalho dos SDKs. Ele envia o PDF, cadastra os signatários, cria a solicitação de assinatura e devolve o ID de cada um para você guardar.

Código aberto no GitHub, com licença MIT e exemplos de uso em cada repositório.

Criar conta grátis Ver no GitHub ↗

.env

# Credenciais do sandbox# Ficam só no servidor, nunca no navegador ou no appASSINAFY_API_KEY=sua_chaveASSINAFY_ACCOUNT_ID=id_do_workspaceASSINAFY_BASE_URL=https://sandbox.assinafy.com.br/v1

SDKs de servidor

Escolha sua linguagem

Os SDKs chamam a mesma API REST da referência, com nomes e convenções de cada linguagem.

Usar a API sem SDK ↗

TypeScript@assinafy/sdknpm install @assinafy/sdk

Pythonassinafypip install assinafy

Rubyassinafygem install assinafy

Gogithub.com/assinafy/golang-sdkgo get github.com/assinafy/golang-sdk

Rustassinafycargo add assinafy

.NETAssinafy.Sdkdotnet add package Assinafy.Sdk

JavaMaven ou Gradle, pelo Maven Centralcom.assinafy:assinafy-sdk

Object PascalFree Pascal 3.2.2, pelo GitHubgit clone github.com/assinafy/object-pascal-sdk

PHPassinafy/php-sdkcomposer require assinafy/php-sdk

Atalho dos SDKs

Enviar o documento e pedir assinatura numa chamada só

O SDK envia o PDF, cadastra os signatários, cria a solicitação de assinatura e devolve o ID de cada um para você guardar.

Respostas como objetos da linguagem, sem tratar JSON na mão
Paginação resolvida pelo SDK

enviar-contrato.ts

import { AssinafyClient } from '@assinafy/sdk';

const client = new AssinafyClient({
  apiKey: process.env.ASSINAFY_API_KEY,
  accountId: process.env.ASSINAFY_ACCOUNT_ID,
});

const resultado = await client
  .uploadAndRequestSignatures({
    source: { filePath: './contrato.pdf' },
    signers: [{
      name: 'Ana Lima',
      email: 'ana@exemplo.com',
    }],
  });