👍
Modelos de documentos
Com esta funcionalidade, você poderá utilizar templates criados em Microsoft Word para criação automática de documentos baseados em metadados. Confira mais em nossa página de Ajuda.

📘
Requisição para a criação de documentos através de Modelos na Clicksign. Esta é uma requisição POST para /api/v1/templates/:key/documents, sendo :key a chave do template na Clicksign. No body, deverão ser enviados os atributos do documento e do template.

POST /api/v1/templates/:key/documents?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Atributos para criação do documento

Atributo	Descrição	Exemplo
`path` Obrigatório	Caminho onde o documento será criado dentro da Clicksign, incluindo o nome do arquivo. Campo deverá começar com "/". Se a pastas e as subpastas não existirem, elas serão criadas automaticamente. Esse campo não representa o caminho do seu servidor. NOTA: É necessário que o path termine com`.docx`.	/Contrato de Prestação de Serviços-123.docx
`template.data` Obrigatório	Campo JSON com as variáveis para serem substituídas no template de documento. Poderá ser enviado um array de itens para serem criados no template.	`{ "Company": "Banco Acme", "Address": "Av. Brasil 277", "Phone": "(11) 1234-5678" }`

Atributo

Descrição

Exemplo

path Obrigatório

Caminho onde o documento será criado dentro da Clicksign, incluindo o nome do arquivo.

Campo deverá começar com "/".
Se a pastas e as subpastas não existirem, elas serão criadas automaticamente.
Esse campo não representa o caminho do seu servidor.

NOTA: É necessário que o path termine com.docx.

/Contrato de Prestação de Serviços-123.docx

template.data
Obrigatório

Campo JSON com as variáveis para serem substituídas no template de documento.

Poderá ser enviado um array de itens para serem criados no template.

{
  "Company": "Banco Acme",
  "Address": "Av. Brasil 277",
  "Phone": "(11) 1234-5678"
}

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

POST /api/v1/templates/996a799a-52ef-4805-ae9f-b2edfd49a730/documents?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

{
  "document": {
    "path": "/Modelos/Teste-123.docx",
    "template": {
      "data": {
        "Company Name": "Clicksign Gestão de Documentos S.A.",
        "Address": "R. Teodoro Sampaio 2767, 10° andar",
        "Phone": "(11) 3145-2570",
        "Website": "https://www.clicksign.com"
      }
    }
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

🚧
Veja em Visualização de documentos a explicação detalhada do JSON de retorno dos documentos.

{
  "document": {
    "key": "9055ca99-32a3-4b29-943f-b041fce91950",
    "path": "/Modelos/Teste-123.docx",
    "filename": "Teste-123.docx",
    "uploaded_at": "2019-01-15T18:09:13.903Z",
    "updated_at": "2019-01-15T18:09:13.903Z",
    "finished_at": null,
    "deadline_at": "2019-02-15T01:59:00.000Z",
    "status": "running",
    "auto_close": true,
    "locale": "pt-BR",
    "metadata": {},
    "sequence_enabled": false,
    "signable_group": null,
    "remind_interval": null,
    "downloads": {
      "original_file_url": "https://clicksign-content-production.s3.amazonaws.com/2019/01/15/18/09/13/f40f2fb4-9a3a-403f-8b9f-9edb78f50144/Teste-2019-01-15T16%3A09%3A14-02%3A00.docx?X-Amz-Expires=300&X-Amz-Date=20190115T180913Z&X-Amz-Security-Token=FQoGZXIvYXdzEMv//////////wEaDLUXbKRlkOZi27g76iK3A6EH%2B1ftUN/GJ83%2BMrlfdx8za3ECDDVK3o8M%2BbdkmpWj9X9t0eHOdExwvLLuNZaf6wu85yk2JqK5kzC7tV5yNAurAODhRWZf27zau%2BUt3P3bUOUxU5MD/2kj9OUtEi97HKDOKIn402rdCQqvaZjGLPCKPVpEFoRNROtlr0OnnEC3BQT/Uk/KwBPl7xC3Nv9pio5C23/QETjucVm7u1bhSO3CNaYWVqdj5lhaEw1rgwwZOdGBACBE/lshgWB32VPHTanDlcNZ1Dja/aZGWsOQ5UdTt4j2jEpgzIkGPR8NbtRQoWxSuALMrZ9FLh2drEhN3%2Bxkcy95q1/aMTVc%2B1f8EPjlH1DP843ZAx9n9DIJ3gUWPNKWD2R03jQCk4e%2Bnc3jQU/s0IZbOLZ50tw0kNXqfiSocMTXNXK%2BAa6aGMaYM2VEBD8cntNOWOQwEg1PY7xAuJNGdlcgiax8cgjEbp0/lcHiaCFIeatzwUqNUvfqOHn1867K3fdq6H3wuhCKAnThEpJ4KrdXNoCdA0B7vM9AWrDL1xM2m8o29dMgRbl4qHQAzRSgs9jeam7ibjd6hgkNe8TfP6rCVzIota/44QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2ERYHIYD6VJ2QNOW/20190115/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=1ed171c517a8bc80a32ab6e7b1b820a7aa7fc065bd2934cf5e54ff211e58d266"
    },
    "template": {
      "key": "996a799a-52ef-4805-ae9f-b2edfd476530",
      "data": {
        "Company Name": "Clicksign Gestão de Documentos S.A.",
        "Address": "R. Teodoro Sampaio 2767, 10° andar",
        "Phone": "(11) 3145-2570",
        "Website": "https://www.clicksign.com"
      }
    },
    "signers": [],
    "events": [
      {
        "name": "upload",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "f43581b0-854d-4765-bb6d-466701f2ebc6"
          },
          "deadline_at": "2019-02-14T23:59:00.000-02:00",
          "auto_close": true,
          "locale": "pt-BR"
        },
        "occurred_at": "2019-01-15T18:09:13.929Z"
      }
    ]
  }
}