Assinafy api
Skills pessoais
npx -y skills add prof-ramos/skills --skill assinafy-apiAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Especialista na API Assinafy para assinatura digital. Use SEMPRE que o usuário mencionar Assinafy, assinatura eletrônica/digital, upload de documento para assinar, signers, assignments, webhooks de documento, templates, field definitions, API key da Assinafy, sandbox Assinafy, ou integração com plataforma de assinatura — mesmo que não cite "API" explicitamente. Orienta upload, signers, assignments (virtual/collect), webhooks e autenticação. Consulta assinafy/assinafy-api-docs/ antes de buscar na web. Use com /assinafy-api.
SKILL.md
3.4 KB, 833 tokens by cl100k_base, as published. Nobody here has run it
Assinafy API
Assinafy é uma plataforma de assinatura digital com API REST.
Antes de implementar
- Identifique a tarefa (upload, assignment, webhook, template, etc.)
- Leia o arquivo de doc local indicado no Decision Tree abaixo
- Se for código, leia também
references/integration-patterns.md - Confirme o ambiente (sandbox em dev, produção só quando o usuário pedir)
Fonte primária: assinafy/assinafy-api-docs/. Consulte https://api.assinafy.com.br/v1/docs apenas se a doc local não cobrir o caso.
Regras importantes
| Regra | Por quê |
|---|---|
Use sandbox (https://sandbox.assinafy.com.br/v1) em desenvolvimento | Evita cobranças e afeta documentos reais |
| API Key só no backend | Chave exposta no frontend permite abuso da conta |
Header X-Api-Key (ou Bearer token) | Forma documentada de autenticação server-side |
Trate status no body e HTTP status | A API retorna erros em ambos os níveis |
Upload via multipart, campo file | Endpoint de upload não aceita JSON com base64 |
virtual = sem campos; collect = com field definitions | Escolha errada quebra o fluxo de assinatura |
| Webhook: validar secret, responder 200, processar idempotente | Retries do provedor reenviam o mesmo evento |
Variáveis de ambiente padrão: ASSINAFY_API_KEY, ASSINAFY_ACCOUNT_ID, ASSINAFY_BASE_URL, ASSINAFY_WEBHOOK_SECRET. Detalhes em references/integration-patterns.md.
Decision Tree — qual doc ler
| Tarefa | Arquivo |
|---|---|
| Primeira integração | assinafy/assinafy-api-docs/README.md, quick-start.md |
| Autenticação / API keys | authentication.md |
| Documentos (upload, download, status) | documents.md + schemas/document.md |
| Signatários | signers.md + schemas/signer.md |
| Solicitar assinatura | assignments.md + schemas/assignment.md |
| Campos no PDF (collect) | field-definitions.md |
| Templates | templates.md |
| Tags | tags.md |
| Fluxo do signatário | signer-documents.md |
| Webhooks | webhooks.md + references/webhook-events.md |
| Paginação, erros, ambientes | basics.md |
| Padrões de código | references/integration-patterns.md |
Todos os caminhos são relativos a assinafy/assinafy-api-docs/ exceto references/.
Fluxo típico
Credenciais → Upload PDF → Criar signers → Assignment → Webhooks → Download certificated
Exemplo — assignment virtual:
{
"method": "virtual",
"signerIds": ["<signer_id>"],
"expires_at": "2026-12-31T23:59:59Z",
"message": "Por favor, assine o documento."
}
Para collect, leia assignments.md seção "Create with Input" antes de implementar.
Referências externas
- Coleção Postman: https://www.postman.com/devassinafy/dev-assinafy-s-workspace/collection/tqqxlsd/assinafy-api-collection
- Códigos de erro HTTP:
assinafy/assinafy-api-docs/basics.md