{"_id":"54dbbde6cb65152100295518","user":"54da5cb85b80b62300dadc4b","version":{"_id":"54da5d305b80b62300dadc51","project":"54da5d2f5b80b62300dadc4e","__v":7,"createdAt":"2015-02-10T19:34:08.062Z","releaseDate":"2015-02-10T19:34:08.062Z","categories":["54da5d305b80b62300dadc52","54da704b11dfeb1900430309","54da705c44b1090d00072b34","54db48c86db3861700c840c5","54db48cd7dadb32300511364","54dbaa0c7dadb3230051143b","572b89f0b352ab0e003daca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1.0","version_clean":"1.0.0","version":"1"},"category":{"_id":"54db48c86db3861700c840c5","__v":13,"version":"54da5d305b80b62300dadc51","pages":["54db4c2c7dadb3230051136b","54db4f1c74dfff3700f161d9","54db53fdeb78f13900cf108e","54db65ec1a14312100313971","54dbad189f8ef11900f4df66","54dbccb800add623007578b4","54ff74002882a10d00546966","55de2abb9067202b00ddfffb","55e4d19fe252ac0d00303a73","5654c2d82308e12b00a14add","56980f9c080e0c0d00a835dc","569810e0895fd40d00d4b2f8","56e30b3051857d0e008e77a1"],"project":"54da5d2f5b80b62300dadc4e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-11T12:19:20.398Z","from_sync":false,"order":0,"slug":"rest-api","title":"Rest API"},"parentDoc":null,"__v":34,"githubsync":"","project":"54da5d2f5b80b62300dadc4e","metadata":{"title":"","description":"","image":[]},"updates":["54dcdc6108f6b61700a691b0"],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T20:39:02.397Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \\n\\nEsta documentação é referente à API da plataforma Clicksign Classic.\",\n  \"title\": \"Utilize a nova plataforma de assinatura\"\n}\n[/block]\nVocê pode realizar download dos documentos da Clicksign a qualquer momento. O download envia um arquivo no **formato ZIP** contendo o documento original e o documento assinado pela Clicksign. \n\nO empacotamento em formato ZIP é realizado sob demanda e em _background_, e para isso, o servidor não irá aguardar a conclusão do empacotamento para retornar a requisição;  ao invés disso, ele retornará uma resposta com _status_ 202 indicando o início do empacotamento.  Enquanto ocorre o empacotamento, o servidor irá retornar a mesma resposta 202.  Quando o processo for concluído, a resposta será código 200 contendo em seu corpo o ZIP.\n\nVocê deverá realizar uma espera ativa, efetuando diversas requisições e obtendo respostas 202 até obter um código 200.  O empacotamento ocorre em 2 ou 3 segundos no máximo, por isso, **recomendamos realizar uma requisição por segundo** até você obter um código 200, dessa forma em 2 ou 3 requisições você obterá o ZIP.\n\n### Requisição\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Method\",\n    \"1-0\": \"Path\",\n    \"2-0\": \"Headers\",\n    \"0-1\": \"`GET`\",\n    \"1-1\": \"`/v1/documents/:key/download?access_token=string`\\n\\n`:key` deve ser substituída pela key do documento. Exemplo: `88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3`\",\n    \"2-1\": \"`Accept: application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n### Resposta - Início do empacotamento\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 202 Accepted\\nContent-Type:application/json\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n### Resposta - Empacotamento concluído\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 200 OK\\nContent-Type:application/json\\nContent-Disposition: attachment; filename=\\\"Documento Word.zip\\\"\\nContent-Transfer-Encoding: binary\\nContent-Type: application/zip\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n... Conteúdo do arquivo ZIP ...\\n\\n\",\n      \"language\": \"text\",\n      \"name\": \"Body\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"download","type":"basic","title":"Download"}
[block:callout] { "type": "danger", "body": "Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \n\nEsta documentação é referente à API da plataforma Clicksign Classic.", "title": "Utilize a nova plataforma de assinatura" } [/block] Você pode realizar download dos documentos da Clicksign a qualquer momento. O download envia um arquivo no **formato ZIP** contendo o documento original e o documento assinado pela Clicksign. O empacotamento em formato ZIP é realizado sob demanda e em _background_, e para isso, o servidor não irá aguardar a conclusão do empacotamento para retornar a requisição; ao invés disso, ele retornará uma resposta com _status_ 202 indicando o início do empacotamento. Enquanto ocorre o empacotamento, o servidor irá retornar a mesma resposta 202. Quando o processo for concluído, a resposta será código 200 contendo em seu corpo o ZIP. Você deverá realizar uma espera ativa, efetuando diversas requisições e obtendo respostas 202 até obter um código 200. O empacotamento ocorre em 2 ou 3 segundos no máximo, por isso, **recomendamos realizar uma requisição por segundo** até você obter um código 200, dessa forma em 2 ou 3 requisições você obterá o ZIP. ### Requisição [block:parameters] { "data": { "0-0": "Method", "1-0": "Path", "2-0": "Headers", "0-1": "`GET`", "1-1": "`/v1/documents/:key/download?access_token=string`\n\n`:key` deve ser substituída pela key do documento. Exemplo: `88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3`", "2-1": "`Accept: application/json`" }, "cols": 2, "rows": 3 } [/block] ### Resposta - Início do empacotamento [block:code] { "codes": [ { "code": "HTTP/1.1 202 Accepted\nContent-Type:application/json", "language": "http" } ] } [/block] ### Resposta - Empacotamento concluído [block:code] { "codes": [ { "code": "HTTP/1.1 200 OK\nContent-Type:application/json\nContent-Disposition: attachment; filename=\"Documento Word.zip\"\nContent-Transfer-Encoding: binary\nContent-Type: application/zip", "language": "http" } ] } [/block] [block:code] { "codes": [ { "code": "\n... Conteúdo do arquivo ZIP ...\n\n", "language": "text", "name": "Body" } ] } [/block]