⚡ Guia Quickstart (Integração em 5 Minutos)
Siga este fluxo simples de 4 passos para realizar a sua primeira assinatura automatizada via API:
1. Visão Geral & Coleção Postman
A API do StitsSign é baseada no padrão REST. Ela utiliza verbos HTTP tradicionais (`GET`, `POST`, `PUT`, `DELETE`), retorna respostas codificadas em formato JSON e utiliza códigos de resposta HTTP padrão.
https://stitssign.fidycard.com.br/api2. Ambientes: Sandbox vs Produção
O StitsSign disponibiliza dois ambientes distintos para garantir a segurança dos testes de integração:
Utilize chaves com prefixo stits_test_.... No modo Sandbox:
- Disparos de E-mail/WhatsApp são simulados em log de teste.
- Sem cobrança de saldo de assinaturas reais.
- Ideal para homologação em staging/local.
Utilize chaves com prefixo stits_live_.... No modo Produção:
- Disparos reais de e-mail e WhatsApp via StitsOS Hub.
- Registro oficial de validade jurídica e selo de tempo.
3. Autenticação & Chaves de API
Todas as requisições para a API do StitsSign devem conter a sua chave de API secreta informada no cabeçalho `Authorization` HTTP no formato Bearer.
Authorization: Bearer stits_live_sua_chave_secreta_aqui4. Gestão de Clientes / Signatários
Antes de gerar contratos, você pode cadastrar a entidade do Cliente/Contratante para reutilizar seus dados cadastrais e preenchimento dinâmico de variáveis em modelos.
/api/clients• Cadastrar novo clienteCria o cadastro do contratante com dados necessários para os termos de assinatura eletrônica.
5. Criação, Gestão & Download de PDF
O endpoint principal de criação de contratos aciona o Motor de Smart Templates do StitsSign (substituindo variáveis dinâmicas), calcula o Hash SHA-256 e dispara notificações via E-mail e WhatsApp.
/api/contracts• Criar e disparar contrato{{NOME_CLIENTE}}{{DOCUMENTO_CLIENTE}}{{EMAIL_CLIENTE}}{{RG_CLIENTE}}{{ENDERECO_CLIENTE}}{{DATA_ATUAL}}/api/contracts/:id/pdf• Obter dados e URL de download do PDF AssinadoRetorna os dados completos do documento assinado, Hash SHA-256 e o relatório detalhado da trilha de auditoria para arquivamento no ERP.
6. Assinaturas & Trilha de Auditoria
Quando um usuário assina a página pública (/sign/:token), o StitsSign registra automaticamente os metadados jurídicos exigidos por lei.
Dados Capturados na Trilha de Auditoria:
- Endereço IP do Signatário
- Carimbo de Tempo (UTC / Selo de Tempo)
- Geolocalização (Latitude/Longitude)
- User-Agent do Navegador & Dispositivo
- SVG / PNG da Assinatura Manual
- Criptografia de Hash SHA-256 no PDF
7. Webhooks & Validação de Segurança HMAC
Evite polling na API! Configure seu webhook para receber requisições HTTP POST instantâneas quando um contrato for assinado.
Validação do Cabeçalho X-Stits-Signature (HMAC-SHA256)
Para evitar ataques de falsificação de webhooks, valide a assinatura enviada no cabeçalho X-Stits-Signature comparando-a com o segredo do webhook cadastrado.
8. SDK Wrappers Leves (Node.js & Python)
Copie estas classes auxiliares leves para integrar o StitsSign na sua aplicação com poucas linhas de código:
9. Códigos de Status & Rate Limits
| Código HTTP | Status | Descrição |
|---|---|---|
| 200 / 201 | OK / Created | A requisição foi processada e executada com sucesso. |
| 400 | Bad Request | Parâmetros obrigatórios ausentes ou JSON mal formatado. |
| 401 | Unauthorized | API Key inválida, revogada ou ausente no cabeçalho. |
| 404 | Not Found | O recurso solicitado (Contrato ou Cliente) não existe. |
| 429 | Too Many Requests | Limite de taxa excedido (Limite padrão: 100 req/min por API Key). |
10. Perguntas Frequentes de Integração (FAQ Técnico)
Qual é a validade jurídica dos documentos assinados via API do StitsSign?
Total validade jurídica em conformidade com a MP 2.200-2/2001 e a Lei 14.063/2020 (Assinatura Eletrônica Avançada). Cada assinatura gera um termo de auditoria contendo o Hash SHA-256, endereço IP, geolocalização, carimbo de tempo UTC e evidências biométricas/desenho.