👍
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 a partir de Modelos na Clicksign. Esta é uma requisição POST para api/v3/envelopes/{{envelopeid}}/documents. No body, deverão ser enviados os atributos do documento e do template.

POST api/v3/envelopes/{{envelopeid}}/documents HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `documents`.	Sim

Atributos para criação do documento

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`filename`	Nome do arquivo do documento a ser criado.	Sim	Sem valor padrão	Ata.doc
`template.key`	Chave do modelo de documento a ser usado para criar o documento. O modelo deve estar previamente cadastrado na plataforma da Clicksign. Para saber mais, acesse a nossa página de Ajuda.	Sim	Sem valor padrão	43a5a2f4-a1df-4367-a47e-aea6e4c6c3d4
`template.data`	Campo JSON com as variáveis a serem substituídas no template de documento. Poderá ser enviado um array de itens para serem criados no template.	Sim	Sem valor padrão	{ "Company Name":"Clicksign Gestão de Documentos S.A.", "Phone":"(11) 3145-2570" }
`metadata`	Metadados do documento, os dados cadastrados serão enviados com o documento nos webhooks para facilitar a identificação deles pelo sistema que implementa a integração.	Não	{}	{ "internal_id": "1" }

❗️
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/v3/envelopes/{{envelopeid}}/documents HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data":{
    "type":"documents",
    "attributes":{
      "filename":"Teste.doc",
      "template":{
        "key":"43a5a2f4-a1df-4367-a47e-aea6e4c6c3d4",
        "data":{
          "Company Name":"Clicksign Gestão de Documentos S.A.",
          "Phone":"(11) 3145-2570",
          "Website":"https://www.clicksign.com"
        },
        "metadata": {
          "key": "value"
        }
      }
    }
  }
}

Response

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

{
  "data":{
    "id":"d22a3f04-3a43-4a24-9235-bc90e803965e",
    "type":"documents",
    "links":{
      "self":"https://3.clicksign.dev/api/v3/envelopes/9291fee8-a80d-4822-bce7-19e08e2446cc/documents/d22a3f04-3a43-4a24-9235-bc90e803965e",
      "files":{
        "original":"https://tavola-staging.s3.amazonaws.com/2023/08/08/19/20/56/74f6eb6d-fb19-45a2-9275-e8723a6890b5/Teste.doc?X-Amz-Expires=300&X-Amz-Date=20230808T192056Z&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIHzX4AYrE9JZ8pSf63wna6uLSFA3Yjyt2D%2BR1OinFaNeAiEAyDkV8xFEJOw0QakXa6g1w0mbtZ93w74xwJ5eqdJ7Ts0qugUIlP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw2NzU3NDQ0MTM1NjkiDJjzH46qOhjgV2TqVyqOBY6HzIutbmPHsXtGSAnDbxBwaMCyqOaG8Kbq5QA%2BBLqtyFDWHx29Is8DjZGkdT4hASRbynwpXa8w%2FuxuCq6Sd38iDpD2vJbswahvKHM5LWjDsFwsZW%2BT5BDtrnIzVAedbn1oZF7EWi%2FHjsyV6nDCZ0mYeQ1PMcR94xBCdjkNkWkLFU6YEQALmXMmkDQfwFAoahZeftPpexbXihW%2FnNgZznw8bhFsT73rdr85Yeiu5%2FTNW3sp%2FSL%2BYokrtFErZGgxgYEpmISxmHrtrXz2Mxl3MDMRGr87xjpN%2BK5%2B2ZDzlXnIKV8R6iMx0aKv1U50cAlWxLl2eAXlgsiXPiOQaYldStRp7EHp3rXy0tG32m%2BN4E90f%2BWcF01OAHuyRarzZADvzvs5dMaTBT8pYd8f5EKyV553VtSAC%2F2DeaVHK0Db1%2F%2BChUjGQGLKx4wmUb3L64KeIYGi0BUysX5Q1zyWGEiF9HhITGF223ia8KMyfkye%2F6ObiXO6VLMj0U%2B%2BLprmpX%2BYsp21NBGV%2FSW%2BRWBbsXTL130GDbXdpnyiVKfdgzqmVVrwKgRxRpHUJL4KXpB%2FYH96BWx2Qb59HJBb4vPRyXHmFxsT0%2BVNquRBx3GGqSSvCfJ%2BysQAsTveQBPgTPoBB23y1HbdAacSOFodQ4vCms3z2C5OoDz8kozZYm6ZHd6CPWufkydNzDq4cHukacNyda8KILGCP8wnyNAPGQq%2BabPDOji4isWuoya2kBQSI7jbsCyi7jNlcYEKj%2FBMDacJb3%2F40wXi4XKAacDmITJoP%2Fp%2FaS2mrLGmeZGrWghRJ9Hq9jPcnXuiK1s6LANz7dYTtL%2BTkTk4Sm2tGsJVmJ2uiAqHbzpVfmNVsKZBeqCWlaqanzDGnsqmBjqxAVXjdXhYZix5rvjMmLZcSw5NTSXsmYJXFvZkdb49OPUL0AKrylIysxt%2F85PFu9nIGPToCKXjSssz7AL3tYeOEjTebBYClbLTTiteR9xr6RBDlMoaxebM7S8zHPPpoKWeaxbixK1dT2J7caRoiHTadpI8xxhEI10%2BAWJ4HdanOsClV7MRhVqCAq%2BcobpiqjIvGQhlWCmWBVV7duY5uZZmMcqcI4pg7LIg3Soxu52Hh1Ryvg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZ2VMBO6AZCSHEUPY%2F20230808%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=a885c38ad5cd723ca2809b065b94ff2fe8388fcfc997277285beb8c2774e2a58"
      }
    },
    "attributes":{
      "status":"draft",
      "filename":"Teste.doc",
      "template":{
        "key":"43a5a2f4-a1df-4367-a47e-aea6e4c6c3d4",
        "data":{
          "Empresa":"Clicksign"
        },
        "metadata": {
          "key": "value"
        }
      },
      "created":"2023-08-08T16:20:56.780-03:00",
      "modified":"2023-08-08T16:20:56.797-03:00"
    }
  }
}