{
  "info": {
    "name": "CLP Assinaturas — Integração pública v1",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "description": "Exemplos sem credenciais. Homologue com dados sintéticos autorizados. Não é sandbox público. Use Postman Vault/valores locais para segredos; não os sincronize nem exporte. A execução de requests depende da habilitação da conta. Nenhuma request é executada pela importação."
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{clp_api_key}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.clpsistemas.com.br"
    },
    {
      "key": "clp_api_key",
      "value": ""
    },
    {
      "key": "envelope_id",
      "value": ""
    },
    {
      "key": "certificate_id",
      "value": ""
    },
    {
      "key": "signature_id",
      "value": ""
    },
    {
      "key": "analysis_id",
      "value": ""
    },
    {
      "key": "invoice_id",
      "value": ""
    },
    {
      "key": "idempotency_key",
      "value": "SUBSTITUA_POR_CHAVE_UNICA_DA_OPERACAO"
    },
    {
      "key": "webhook_url",
      "value": "https://erp.example.com/webhooks/clp"
    },
    {
      "key": "pfx_password",
      "value": ""
    }
  ],
  "item": [
    {
      "name": "GET /public/plans",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/public/plans",
        "description": "Consultar os planos públicos e suas franquias. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "auth": {
          "type": "noauth"
        }
      }
    },
    {
      "name": "GET /v1/account/subscription",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/account/subscription",
        "description": "Consultar vigência, plano e uso compartilhado de documentos. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/account/renew",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/account/renew",
        "description": "Criar ou reutilizar a fatura do ciclo; depende do provedor de pagamento habilitado. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/account/invoices",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/account/invoices",
        "description": "Listar até 200 faturas, da mais recente para a mais antiga. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/account/invoices/{id}",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/account/invoices/{{invoice_id}}",
        "description": "Consultar uma fatura da empresa. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/account/invoices/{id}/check",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/account/invoices/{{invoice_id}}/check",
        "description": "Conferir a fatura no provedor de pagamento. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/account/usage",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/account/usage",
        "description": "Consultar histórico mensal de assinaturas diretas; franquia total em account/subscription. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "PUT /v1/account/webhook",
      "request": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "{{base_url}}/v1/account/webhook",
        "description": "Configurar URL HTTPS e obter o segredo HMAC. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"url\": \"{{webhook_url}}\",\n  \"rotate_secret\": false\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "DELETE /v1/account/webhook",
      "request": {
        "method": "DELETE",
        "header": [],
        "url": "{{base_url}}/v1/account/webhook",
        "description": "Remover a configuração de webhook. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/account/webhook/test",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/account/webhook/test",
        "description": "Enfileirar webhook.test; 202 não comprova entrega. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/account/webhook/deliveries",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/account/webhook/deliveries",
        "description": "Listar as 50 entregas de webhook mais recentes. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/certificates",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/certificates",
        "description": "Importar certificado próprio, com autorização expressa em multipart. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "pfx",
              "type": "file",
              "src": []
            },
            {
              "key": "password",
              "value": "{{pfx_password}}",
              "type": "text"
            },
            {
              "key": "accept_authorization",
              "value": "true",
              "type": "text"
            }
          ]
        }
      }
    },
    {
      "name": "GET /v1/certificates",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/certificates",
        "description": "Listar certificados da empresa. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/certificates/{id}",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/certificates/{{certificate_id}}",
        "description": "Consultar metadados de um certificado. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "DELETE /v1/certificates/{id}",
      "request": {
        "method": "DELETE",
        "header": [],
        "url": "{{base_url}}/v1/certificates/{{certificate_id}}",
        "description": "Bloquear o uso e remover o certificado do cofre. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/envelopes/protection",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/protection",
        "description": "Consultar disponibilidade da proteção pelo prestador. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/envelopes",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Idempotency-Key",
            "value": "{{idempotency_key}}"
          }
        ],
        "url": "{{base_url}}/v1/envelopes",
        "description": "Criar envelope e enfileirar convites; não retorna links individuais. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "pdf",
              "type": "file",
              "src": []
            },
            {
              "key": "title",
              "type": "text",
              "value": "Contrato de teste autorizado"
            },
            {
              "key": "external_id",
              "type": "text",
              "value": "PEDIDO-1042"
            },
            {
              "key": "protection_mode",
              "type": "text",
              "value": "platform"
            },
            {
              "key": "recipients",
              "type": "text",
              "value": "[{\"name\":\"Ana Exemplo\",\"email\":\"ana@example.com\"}]"
            }
          ]
        }
      }
    },
    {
      "name": "GET /v1/envelopes",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/envelopes",
        "description": "Listar envelopes em array, 100 por página. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/envelopes/{id}",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}",
        "description": "Consultar envelope e situação dos destinatários. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/envelopes/{id}/signing-links",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/signing-links",
        "description": "Consultar links privados dos destinatários pendentes; exige envelope aberto e não expirado. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/envelopes/{id}/files/{kind}",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/files/final",
        "description": "Baixar original, final ou evidence com autenticação. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/envelopes/{id}/files/{kind}/link",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/files/final/link",
        "description": "Obter link curto quando disponível; direct=false exige download normal. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/envelopes/{id}/cancel",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/cancel",
        "description": "Cancelar envelope em sent. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/envelopes/{id}/resend",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/resend",
        "description": "Reenviar convites pendentes, até três operações/hora. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/envelopes/{id}/delivery-receipts",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/delivery-receipts",
        "description": "Registrar arquivamento após conferir os hashes dos três arquivos. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"original_sha256\": \"SUBSTITUA_PELO_SHA256\",\n  \"final_sha256\": \"SUBSTITUA_PELO_SHA256\",\n  \"evidence_sha256\": \"SUBSTITUA_PELO_SHA256\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "POST /v1/envelopes/{id}/retry",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/retry",
        "description": "Retomar uma finalização em sealing_failed. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "PUT /v1/envelopes/{id}/certificate",
      "request": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "{{base_url}}/v1/envelopes/{{envelope_id}}/certificate",
        "description": "Retomar falha com certificado válido antes de existir PDF final; {} em platform. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "raw",
          "raw": "{}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "POST /v1/signatures",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Idempotency-Key",
            "value": "{{idempotency_key}}"
          }
        ],
        "url": "{{base_url}}/v1/signatures",
        "description": "Assinar diretamente com certificado próprio; sem fluxo de aceites nem guarda do PDF. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "pdf",
              "type": "file",
              "src": []
            },
            {
              "key": "certificate_id",
              "type": "text",
              "value": "{{certificate_id}}"
            }
          ]
        }
      }
    },
    {
      "name": "GET /v1/signatures",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/signatures",
        "description": "Listar registros de assinaturas diretas, com paginação e filtros. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "GET /v1/signatures/{id}",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/signatures/{{signature_id}}",
        "description": "Consultar auditoria de uma assinatura direta. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/verify",
      "request": {
        "method": "POST",
        "header": [],
        "url": "{{base_url}}/v1/verify",
        "description": "Verificar integridade e cadeia das assinaturas do PDF; não é análise jurídica. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "pdf",
              "type": "file",
              "src": []
            }
          ]
        }
      }
    },
    {
      "name": "GET /v1/ai/capabilities",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/ai/capabilities",
        "description": "Consultar disponibilidade e franquia do piloto de IA. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/ai/analyses",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Idempotency-Key",
            "value": "{{idempotency_key}}"
          }
        ],
        "url": "{{base_url}}/v1/ai/analyses",
        "description": "Analisar PDF com autorização específica; não envia convites. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "pdf",
              "type": "file",
              "src": []
            },
            {
              "key": "allow_ai_processing",
              "value": "true",
              "type": "text",
              "description": "Use somente se autorizado a enviar o texto ao Google Gemini."
            }
          ]
        }
      }
    },
    {
      "name": "GET /v1/ai/analyses/{id}",
      "request": {
        "method": "GET",
        "header": [],
        "url": "{{base_url}}/v1/ai/analyses/{{analysis_id}}",
        "description": "Consultar análise da empresa enquanto o rascunho estiver disponível. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "DELETE /v1/ai/analyses/{id}",
      "request": {
        "method": "DELETE",
        "header": [],
        "url": "{{base_url}}/v1/ai/analyses/{{analysis_id}}",
        "description": "Descartar o resultado do rascunho; não altera resumo já vinculado a envelope. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada."
      }
    },
    {
      "name": "POST /v1/ai/analyses/{id}/compare",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "{{base_url}}/v1/ai/analyses/{{analysis_id}}/compare",
        "description": "Conferir dados do ERP contra trechos extraídos, sem nova chamada ao modelo. Consulte a documentação; chamadas de escrita podem criar envios ou faturas reais em conta habilitada.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"monthly_amount_brl\": 249.9,\n  \"term_months\": 12\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    }
  ]
}