Esta é a documentação oficial da API do PlugSign, com ela você pode realizar todas as manipulações de documentos, contas, solicitações de assinatura e etc de forma integrada com seu software e/ou ERP.
Esta é a documentação oficial da API do PlugSign. Com ela você pode manipular documentos, contas, solicitações de assinatura e muito mais, de forma integrada ao seu software ou ERP.
A API espelha processos que ocorrem diretamente no sistema, portanto é recomendado que você acesse o portal e confira como o fluxo padrão dos dados opera antes de começar a implementação.
Confira neste vídeo rápido um fluxo completo, do início ao fim:
https://youtu.be/GdUDlvXP4Uw
Endereço base
Todas as rotas desta referência começam com https://app.plugsign.com.br. Se você utiliza o sistema white label com domínio próprio, substitua pelo seu domínio (por exemplo https://app.seudominio.com.br): o token e os dados são os mesmos, apenas o endereço muda.
Autenticação com Bearer Token
Para acessar os recursos protegidos é necessário enviar um Bearer Token no cabeçalho de todas as requisições.
Como obter o token
- Acesse https://app.plugsign.com.br (ou o seu domínio white label).
- Vá em Ajustes, depois em Configurações e Integração via API.
- Gere um novo token e copie-o.
Como usar
Authorization: Bearer {seu_token_aqui}O token não expira, mas pode ser desativado pela conta que o gerou; mantenha-o em segredo. Todas as chamadas autenticadas ficam registradas e podem ser consultadas em GET /api/logs.
Cabeçalho Accept (obrigatório)
Envie Accept: application/json em todas as requisições. Sem esse cabeçalho, os erros de validação não retornam o JSON de erro (código 422): a API responde com um redirecionamento (código 302) e a mensagem de erro se perde.
Erros de autenticação
| Situação | Código | Corpo |
|---|---|---|
Cabeçalho Authorization ausente | 404 | {"error": "Authorization not found."} |
| Token inexistente ou inválido | 404 | {"error": "Token not found!"} |
| Conta inativa | 403 | {"error": "inactive account."} |
| Usuário do token não encontrado | 200 | {"error": "User not found"} |
Limites de uso
- Cada plano de API tem um limite de requisições. Ao excedê-lo, a resposta é
429com{"message": "Limite de requisições excedido."}. - Há um limite de 60 requisições por minuto por token; acima disso a resposta também é
429. - Limites personalizados da empresa (usuários, clientes, armazenamento e envios) respondem
403com a mensagem do limite atingido nas rotas de criação de usuários e clientes, upload de arquivos e envio de solicitações.
Códigos de resposta
Esta referência mostra o código HTTP real de cada rota. Rotas de criação respondem 201 Created, algumas exclusões respondem 204 No Content sem corpo, e erros de validação respondem 422 com {"message": "...", "errors": {...}}.