SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
      • Gerar um cliente (SDK)
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Listar chamadas da própria chave
        • Consultar consumo do ciclo
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Duplicar envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Consultar envelope
        • Mover envelope para outra pasta
        • Anular envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Recusar como participante aprovador
        • Corrigir contato do participante
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Validar um documento selado
        • Reordenar documentos do envelope
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar grupos da conta
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Listar webhooks
        • Criar webhook
        • Atualizar webhook
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
        • Apagar modelo em rascunho
        • Reordenar documentos do modelo
        • Remover documento do modelo
        • Definir cópias do modelo
      • Auditoria e relatórios
        • Listar envelopes anulados
        • Relatório de envelopes
        • Relatório de uso por grupo
      • Etiquetas
        • Aplicar etiqueta ao envelope
        • Remover etiqueta do envelope
        • Listar etiquetas da conta
  1. Introdução

Gerar um cliente (SDK)

A SuperSign não publica um pacote de SDK. O contrato OpenAPI da API pública é a fonte oficial, e com ele você gera um cliente tipado na linguagem da sua integração. Quando a API ganha um recurso, basta gerar o cliente de novo.

Fonte#

Contrato OpenAPI (Sandbox): https://api.sandbox.supersign.com.br/openapi.json
Use somente as rotas /v4/api/* que aparecem nesse contrato.
Gere a partir do Sandbox e aponte para Produção só pela URL base, sem gerar de novo.

TypeScript#

Com o @hey-api/openapi-ts:
Fixe o TypeScript na versão 5: o gerador ainda não funciona com o TypeScript 7.
import { client } from './supersign/client.gen'
import { getEnvelopes, postEnvelopesEnvelopeIdDuplicate } from './supersign/sdk.gen'

client.setConfig({
  baseUrl: 'https://api.sandbox.supersign.com.br',
  headers: { Authorization: `Bearer ${process.env.SUPERSIGN_API_KEY}` },
})

const lista = await getEnvelopes({ query: { status: 'SENT', perPage: 50 } })
if (lista.error) {
  // Decida pelo código, nunca pelo texto da mensagem.
  console.error(lista.error.error.code)
} else {
  const primeiro = lista.data.envelopes[0]
  const copia = await postEnvelopesEnvelopeIdDuplicate({
    path: { envelopeId: primeiro.id },
    headers: { 'Idempotency-Key': crypto.randomUUID() },
    body: { title: 'Cópia' },
  })
}

Python, PHP, Java e outras#

Com o OpenAPI Generator:
Troque -g python por php, java, csharp ou go, conforme a linguagem.

Padrão da casa#

O cliente gerado cuida dos tipos. As regras abaixo ficam por conta da sua integração:
Autenticação: envie Authorization: Bearer ss_... em toda chamada. A chave fica no servidor, em variável de ambiente, e nunca vai para o navegador, o app ou os logs.
Idempotência: mande uma Idempotency-Key em todo POST. Se repetir a mesma operação depois de um timeout, reutilize a mesma chave. Veja Idempotência e erros.
Erros: toda resposta de erro segue o formato ApiError (ou ValidationError no 400). Trate pelo error.code. A lista de códigos é aberta: um código novo pode surgir sem aviso de quebra, então tenha um caminho padrão para códigos desconhecidos. Veja o Catálogo de erros.
Paginação: as listagens devolvem meta no formato PaginationMeta. Percorra as páginas até totalPages. Veja Paginação e filtros.
Limites: num 429, espere e tente de novo. Veja Limites de requisição.
Versão: quando o Changelog registrar uma mudança, gere o cliente de novo e rode seus testes.
Modificado em 2026-09-29 21:40:20
Página anterior
Criar um envelope a partir de um modelo
Próxima página
Consultar a conta da integração
Built with