Documentação

Introdução

A API SimpleSigner permite assinar documentos PDF digitalmente usando certificados A1 de forma automatizada. A API segue os princípios REST e retorna respostas em JSON.

Base URL: https://www.simplesigner.com.br/

Formato de Resposta: JSON

Protocolo: HTTPS recomendado para produção

Autenticação

Todas as chamadas de API requerem autenticação via header X-Auth-Token. Este token é único para cada empresa e pode ser obtido no painel de controle.

Header de Autenticação

X-Auth-Token: SEU_TOKEN_AQUI

Erros de Autenticação

Assinar Documento (Upload)

Envia um arquivo PDF para ser assinado digitalmente com o certificado A1 configurado na sua conta.

Headers Obrigatórios

Headers Opcionais

Parâmetros (Multipart/Form-Data)

Exemplo de Resposta (Sucesso - 200)

{
  "success": true,
  "message": "Arquivo assinado com sucesso",
  "link": "https://www.simplesigner.com.br/Sign/DownloadDoc/abc123def456...",
  "validationCode": "abc123def456",
  "secretCode": "472819",
  "qrCodeUrl": "https://www.simplesigner.com.br/Sign/Validate/abc123def456"
}

Possíveis Erros

Upload de Certificado

Atualiza ou cadastra o certificado digital A1 (.pfx) da empresa. Este certificado será usado para assinar todos os documentos.

Headers Obrigatórios

Parâmetros

Exemplo de Resposta (Sucesso - 200)

{
  "success": true,
  "message": "Certificado salvo com sucesso"
}

Possíveis Erros

Verificar Status do Certificado

Verifica se há um certificado cadastrado, se está válido e ativo.

Headers Obrigatórios

Exemplo de Resposta (Certificado Válido - 200)

{
  "success": true,
  "certificateRegistered": true,
  "certificateValid": true,
  "certificateActive": true,
  "message": "Certificado válido até 15/12/2026 10:30:00",
  "subject": "EMPRESA EXEMPLO LTDA",
  "issuer": "AC CERTISIGN G6",
  "notBefore": "2024-12-15T10:30:00",
  "notAfter": "2026-12-15T10:30:00",
  "daysUntilExpiration": 320
}

Exemplo de Resposta (Certificado Expirado - 200)

{
  "success": true,
  "certificateRegistered": true,
  "certificateValid": false,
  "certificateActive": false,
  "message": "O certificado expirou em 15/01/2025 10:30:00"
}

Exemplo de Resposta (Sem Certificado - 200)

{
  "success": true,
  "certificateRegistered": false,
  "certificateValid": false,
  "certificateActive": false,
  "message": "Certificado não cadastrado"
}

Possíveis Erros

Códigos de Erro HTTP

A API utiliza códigos de status HTTP padrão para indicar sucesso ou falha das requisições.

Exemplos de Integração

Veja como chamar a API nas principais linguagens.

• C#
• PHP
• Java
• Python

using System.Net.Http;
using System.Net.Http.Headers;
using System.IO;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Auth-Token", "SEU_TOKEN");

var form = new MultipartFormDataContent();
var fileContent = new ByteArrayContent(File.ReadAllBytes("documento.pdf"));
fileContent.Headers.ContentType = MediaTypeHeaderValue.Parse("application/pdf");
form.Add(fileContent, "file", "documento.pdf");

var response = await client.PostAsync("https://www.simplesigner.com.br/Sign/Upload", form);
var result = await response.Content.ReadAsStringAsync();

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.simplesigner.com.br/Sign/Upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ["X-Auth-Token: SEU_TOKEN"],
  CURLOPT_POSTFIELDS => [
    'file' => new CURLFile('/path/to/documento.pdf')
  ]
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

// Usando OkHttp
OkHttpClient client = new OkHttpClient();

RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
    .addFormDataPart("file", "documento.pdf",
        RequestBody.create(MediaType.parse("application/pdf"), new File("documento.pdf")))
    .build();

Request request = new Request.Builder()
    .url("https://www.simplesigner.com.br/Sign/Upload")
    .addHeader("X-Auth-Token", "SEU_TOKEN")
    .post(body)
    .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());

import requests

url = "https://www.simplesigner.com.br/Sign/Upload"
headers = {"X-Auth-Token": "SEU_TOKEN"}
files = {"file": open("documento.pdf", "rb")}

response = requests.post(url, headers=headers, files=files)
print(response.json())