Documentos¶
Um documento na Aceitou é o "envelope" que junta:
- Metadados (título, descrição, expiração, tags)
- Arquivo(s) PDF (anexado direto ou gerado a partir de template)
- Signatário(s) com método de verificação e ordem de assinatura
- Status que avança automaticamente conforme assinaturas chegam
Terminologia
A Aceitou não usa o termo "envelope" — é sempre documento. Endpoints: /api/v1/documents. Pra evitar confusão, o "documento original" (PDF) é referenciado como arquivo do documento.
Status¶
stateDiagram-v2
[*] --> Draft: POST /documents
Draft --> Sent: POST /documents/{id}/send
Sent --> InProgress: primeiro signatário assina
InProgress --> Completed: todos assinaram
Sent --> Cancelled: cancelado pelo dono
InProgress --> Cancelled: cancelado
Sent --> Rejected: signatário rejeita
InProgress --> Rejected: signatário rejeita
Sent --> Expired: ExpiresAt vence
InProgress --> Expired: ExpiresAt vence
| Status | O que significa |
|---|---|
Draft |
Acabou de ser criado, ainda sem signatário ou arquivo |
Sent |
Convites enviados, aguardando assinaturas |
InProgress |
Pelo menos um signatário já assinou |
Completed |
Todos os signatários assinaram — PDF assinado disponível pra download |
Cancelled |
Cancelado pelo dono — signatários são notificados |
Rejected |
Um signatário recusou — ninguém mais pode assinar |
Expired |
ExpiresAt venceu antes da conclusão |
Configurações úteis¶
Na criação (POST /documents):
| Campo | Default | O que faz |
|---|---|---|
title |
obrigatório | Aparece nos emails de convite e no portal de assinatura |
description |
null | Detalhes adicionais mostrados ao signatário |
expirationDays |
30 | Dias após send em que o documento expira (1–365) |
reminderIntervalDays |
3 | Quantos dias entre lembretes automáticos aos signatários (1–30) |
tags |
[] |
Strings livres pra você filtrar no GET /documents?tag=X |
Operações comuns¶
| Quero... | Endpoint |
|---|---|
| Criar um documento vazio | POST /api/v1/documents |
| Anexar PDF | POST /api/v1/documents/{id}/documents (multipart) |
| Gerar PDF a partir de template | POST /api/v1/documents/{id}/documents/from-template |
| Adicionar signatário | POST /api/v1/documents/{id}/signers |
| Disparar assinatura | POST /api/v1/documents/{id}/send |
| Consultar status | GET /api/v1/documents/{id} |
| Listar com filtros | GET /api/v1/documents?status=Sent&tag=urgente |
| Cancelar | POST /api/v1/documents/{id}/cancel |
| Baixar PDF (original ou assinado) | GET /api/v1/documents/{id}/download?version=signed |
| Trilha de auditoria | GET /api/v1/documents/{id}/audit-trail |