Recursos

API de integração

Automatize a criação, o envio e o acompanhamento de envelopes a partir do seu sistema, sem ninguém precisar abrir a plataforma.

Suba o documento, monte o envelope com signatários e validações, publique e consulte o status: o fluxo completo em chamadas REST.

POST /v1/ecm/envelopes
curl -X POST https://api.signater.com/v1/ecm/envelopes \
  -H "x-api-token: $SIGNATER_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vaultId": "5b8f6c2e-8a34-4f4b-9a4e-2f1c3d7e9a01",
    "name": "Contrato de prestação de serviços",
    "language": "PtBr",
    "signers": [
      { "name": "Ana Souza", "email": "[email protected]" }
    ],
    "documents": [
      { "id": "9c7d1a3f-6b2e-4c5d-8e9f-0a1b2c3d4e5f",
        "name": "Contrato" }
    ]
  }'

O que dá para automatizar

De envelopes a evidências, os recursos REST cobrem o ciclo completo de assinatura, para o seu sistema orquestrar tudo sem ninguém abrir a plataforma.

Envelopes

Monte, publique e acompanhe cada etapa, do rascunho ao arquivo certificado final. Pausar, cancelar e reenviar convites também são chamadas da API.

Documentos

O upload aceita PDF, Word, planilha e imagem, sempre com conversão para PDF. O ID retornado entra direto no envelope.

Templates

Um template aprovado vira documento novo em uma única chamada, com os dados variáveis preenchidos pelo seu sistema.

Contatos

Cadastre signatários recorrentes uma vez; nos próximos envios, nome, e-mail e telefone já vêm prontos.

Cofres

Separe clientes ou áreas em cofres e escolha quem é membro de cada um. Todo envelope criado pela API mora em um deles.

Evidências

Baixe o PDF assinado, o original e o arquivo certificado por chamada direta, prontos para arquivar no seu sistema.

Autenticação e limites

Chaves revogáveis e limites previsíveis

Toda chamada é autenticada com uma chave de API enviada no cabeçalho dedicado x-api-token. Crie uma chave para cada sistema que integra, com nome e descrição próprios, e revogue qualquer uma sem derrubar as outras.

O tráfego é limitado por chave e por endereço IP, em janela deslizante. Quem passa do limite recebe HTTP 429 com resposta padronizada, fácil de tratar com uma política de retry no seu cliente.

Sandbox

Teste a integração sem tocar a produção

Cofres e chaves de API podem ser criados em modo sandbox. Os envelopes de teste nascem nesse cofre isolado, longe dos documentos reais da conta.

No sandbox, os fatores de autenticação rodam de forma simplificada: códigos de teste substituem os disparos reais, e você valida o fluxo inteiro sem incomodar nenhum signatário de verdade.

Webhooks

Seu sistema sabe na hora, sem polling

Cada evento do envelope — publicado, assinado, concluído — dispara um webhook para o seu endpoint, com retentativa automática.

Conhecer os webhooks

Documentação

Referência interativa, direto da especificação

A documentação em docs.api.signater.com nasce da especificação OpenAPI da própria API: todos os endpoints, com parâmetros, exemplos de payload e códigos de resposta.

Explore as chamadas no navegador antes da primeira linha de código, e volte sempre que precisar do formato exato de um campo.

GET /v1/ecm/envelopes/{envelopeId} — resposta
{
  "id": "b4c2f8d1-3e5a-4b6c-9d7e-1f2a3b4c5d6e",
  "name": "Contrato de prestação de serviços",
  "status": "Published",
  "signInOrder": false,
  "signers": [
    {
      "name": "Ana Souza",
      "status": "Approved",
      "approvedAtUtc": "2026-07-02T14:32:08Z"
    },
    {
      "name": "Carlos Lima",
      "status": "ReadyToReview"
    }
  ]
}

Perguntas frequentes

Em quais planos a API está disponível?

Nos planos Business e Enterprise, junto com os webhooks e o ambiente de sandbox. Não há cobrança extra pelo acesso: contratou um desses planos, a API está liberada.

Como autentico minhas chamadas?

Cada requisição leva uma chave de API no cabeçalho dedicado x-api-token. Você cria as chaves na própria plataforma, pode manter várias ativas ao mesmo tempo e revogar qualquer uma na hora, sem afetar as demais.

Existe ambiente de testes?

Sim. Cofres e chaves de API podem ser criados em modo sandbox: os envelopes de teste ficam isolados e os fatores de autenticação rodam de forma simplificada, com códigos de teste. Você valida a integração sem tocar nos dados de produção.

Documentos enviados pela API custam à parte?

Não. Documentos criados pela API consomem o mesmo saldo do plano que os criados na plataforma. Não existe tarifa por chamada nem cobrança separada para integrações.

A API avisa meu sistema quando algo acontece?

Sim, via webhooks: eventos como envelope.published, envelope.signed e envelope.expired são entregues no seu endpoint, com retentativa automática se ele estiver indisponível.

Onde encontro a documentação?

Em docs.api.signater.com. A referência é gerada a partir da especificação OpenAPI da API e cobre todos os endpoints, com parâmetros, exemplos de requisição e códigos de resposta.

Pessoas em frente a um laptop analisando sua tela

Fale com a equipe

Monte sua integração com a gente

Nossa equipe revisa o seu caso de uso: quais endpoints usar, como estruturar os envelopes e o que validar no sandbox antes de ir para produção. Tire suas dúvidas direto no WhatsApp.