Esta é a documentação oficial da API do PlugSign, com ela você pode realizar todas as manipulações de documentos, contas, solicitações de assinatura e etc de forma integrada com seu software e/ou ERP.
\nA API espelha processos que ocorrem diretamente no sistema, portanto é recomendado que você acesse o portal e confira como o fluxo padrão dos dados opera antes de começar a implementação.
\nO fluxo de dados mais comum realizado via PlugSign é a solicitação de assinatura(s) em um documento, para este fluxo básico recomenda-se o seguinte:
\nDesta forma você pode ver que o fluxo via API é simplificado, com menos etapas por não ter os artefatos visuais necessários via front-end.
\nConfira neste vídeo rápido mostrando um fluxo completo, do início ao fim:
https://youtu.be/GdUDlvXP4Uw
Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/folders?name=Contratos de venda&folder=360&accesbility=Departments&departments[0]=38","description":"Com este endpoint você pode criar pastas no PlugSign, também é possível criar subpastas para melhor organização dos documentos.
\nAo criar uma pasta você irá receber o ID da mesma, que é o identificador único dela no sistema, que pode ser utilizado para recuperar documentos e até mesmo enviar documentos para pastas específicas.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","folders"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Nome da pasta visível dentro da plataforma
\n","type":"text/plain"},"key":"name","value":"Contratos de venda"},{"description":{"content":"[Opcional][Int] Pasta dentro da qual esta deve ser criada, caso nada seja passado ela será criada na pasta raíz
\n","type":"text/plain"},"key":"folder","value":"360"},{"description":{"content":"[Opcional][String] Everyone,Departments,OnlyMe] Visibilidade padrão da pasta, dentro dos 3 tipos permitidos
\n","type":"text/plain"},"key":"accesbility","value":"Departments"},{"description":{"content":"[Opcional][Array] Só é obrigatório se no campo de acesso passar departamentos, recebe uma lista dos departamentos da empresa que passam a ter acesso a pasta.
\n","type":"text/plain"},"key":"departments[0]","value":"38"}],"variable":[]}},"response":[{"id":"cc88a96c-aed1-4473-9df7-70d909302144","name":"Create folder","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/folders?name=Contratos de venda&folder=360&accesbility=Everyone","protocol":"https","host":["app","plugsign","com","br"],"path":["api","folders"],"query":[{"key":"name","value":"Contratos de venda","description":"[Obrigatório][String] Nome da pasta visível dentro da plataforma"},{"key":"folder","value":"360","description":"[Opcional][Int] Pasta dentro da qual esta deve ser criada, caso nada seja passado ela será criada na pasta raíz"},{"key":"accesbility","value":"Everyone","description":"[Opcional][String Everyone,Departments,OnlyMe] Visibilidade padrão da pasta, dentro dos 3 tipos permitidos"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:42:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 461,\n \"folder\": \"Contratos de venda\",\n \"accessibility\": \"Everyone\",\n \"sub_folders\": [],\n \"created_on\": \"24/08/2022 10:42:02\"\n },\n \"message\": \"Pasta Criada com sucesso!\"\n}"}],"_postman_id":"116797a1-e211-47f2-8f24-7d5581635a86"},{"name":"Get folders","id":"134b055b-2ec3-447e-a3eb-f92869540945","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/folders?id=461&name=Contratos de venda&accessibility=OnlyMe","description":"Com este endpoint você pode listar todas as pastas ou pastas específicas na plataforma, lembrando que a API também vai retornar subasptas como objetos secundários.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","folders"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Opcional][Int] ID da pasta no sistema, pode ser obtido com o list folders geral (Sem filtros)
\n","type":"text/plain"},"key":"id","value":"461"},{"description":{"content":"[Opcional][String] Nome da pasta visível no sistema
\n","type":"text/plain"},"key":"name","value":"Contratos de venda"},{"description":{"content":"[Opcional][String Everyone,Departments,OnlyMe] Nível de acesso da pasta para usuários do sistema
\n","type":"text/plain"},"key":"accessibility","value":"OnlyMe"}],"variable":[]}},"response":[{"id":"62e78bb8-9ed7-49d0-8453-deb826a0570a","name":"Get folders","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/folders?id=461&name=Contratos de venda&accessibility=OnlyMe","protocol":"https","host":["app","plugsign","com","br"],"path":["api","folders"],"query":[{"key":"id","value":"461","description":"[Opcional][Int] ID da pasta no sistema, pode ser obtido com o list folders geral (Sem filtros)"},{"key":"name","value":"Contratos de venda","description":"[Opcional][String] Nome da pasta visível no sistema"},{"key":"accessibility","value":"OnlyMe","description":"[Opcional][String Everyone,Departments,OnlyMe] Nível de acesso da pasta para usuários do sistema"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:44:53 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 461,\n \"folder\": \"Contratos de venda\",\n \"sub_folders\": [],\n \"files\": [],\n \"accessibility\": \"Only Me\",\n \"created_on\": \"24/08/2022 10:44:24\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/folders?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/folders?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/folders?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/folders\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"134b055b-2ec3-447e-a3eb-f92869540945"},{"name":"Update folder","id":"459f02a7-6d4d-40e7-a514-b2ce4d7e754b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/folders/6207?name=Minha pasta importante!&accessibility=Departments&departments[0]=38","description":"Com este endpoint você pode atualizar informações das pastas, caso precise altera o nome ou a visibilidade da mesma.
\nO único item que não pode ser alterado é o ID, o mesmo é o identificador único da pasta que deve ser utilizado quando for enviar um documento para a mesma.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","folders","6207"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Novo nome para a pasta
\n","type":"text/plain"},"key":"name","value":"Minha pasta importante!"},{"description":{"content":"[Obrigatório][String] Everyone,Departments,OnlyMe] Nova visibilidade da pasta
\n","type":"text/plain"},"key":"accessibility","value":"Departments"},{"description":{"content":"[Opcional][Array] Só é obrigatório se no campo de acesso passar departamentos, recebe uma lista dos departamentos da empresa que passam a ter acesso a pasta.
\n","type":"text/plain"},"key":"departments[0]","value":"38"}],"variable":[]}},"response":[{"id":"f6d7b2d2-4718-471f-8fa1-ba11086c4eed","name":"Update folder","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/folders/{{folder_id}}?name=Contratos de venda&accessibility=OnlyMe","protocol":"https","host":["app","plugsign","com","br"],"path":["api","folders","{{folder_id}}"],"query":[{"key":"name","value":"Contratos de venda","description":"[Obrigatório][String] Novo nome para a pasta"},{"key":"accessibility","value":"OnlyMe","description":"[Obrigatório][String Everyone,Departments,OnlyMe] Nova visibilidade da pasta"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:44:24 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Pasta editada com sucesso!\",\n \"data\": {\n \"name\": \"Contratos de venda\",\n \"accessibility\": \"Only Me\"\n }\n}"}],"_postman_id":"459f02a7-6d4d-40e7-a514-b2ce4d7e754b"},{"name":"Delete folder","id":"f1f2e083-9c8b-4c7e-a1f7-344b1cbf3be6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/folders/{{folder_id}}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","folders","{{folder_id}}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1f2e083-9c8b-4c7e-a1f7-344b1cbf3be6"}],"id":"1bd0c76a-ef37-47f6-b7a0-1ce51ed7b5f7","description":"Os endpoints de folders permitem que você crie uma estrutura de pastas para melhor organizar os documentos.
\nEsta estrutura fica visível aos usuários do front-end, permitindo que eles acessem os documentos de forma prática.
\nCaso não utilize a estrutura de pastas, todos os documentos vão ser enviados para a pasta raiz, o que pode tornar o acesso e a localização de documentos trabalhosa.
\n","_postman_id":"1bd0c76a-ef37-47f6-b7a0-1ce51ed7b5f7","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Files","item":[{"name":"TAGS","item":[{"name":"Add TAG","id":"78e4c1ba-7bbd-43c8-becf-3d7705308635","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/files/tags/name?file_id=124472&name[0]=Minha TAG","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","tags","name"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][INT] ID do documento cujuas tags vão ser adicionadas.
\n","type":"text/plain"},"key":"file_id","value":"124472"},{"description":{"content":"[Obrigatório][Array] Tags que vão ser adicionadas ao documento, caso não existam são criadas.
\n","type":"text/plain"},"key":"name[0]","value":"Minha TAG"}],"variable":[]}},"response":[{"id":"396a9247-f67f-4b81-9d0c-d51c9f7f01cc","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/files/tags/name?file_id=124472&name[0]=Minha TAG","protocol":"https","host":["app","plugsign","com","br"],"path":["api","files","tags","name"],"query":[{"key":"file_id","value":"124472","type":"text"},{"key":"name[0]","value":"Minha TAG","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:24:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Ngm%2BtTN1IL7TEIuTCLbdT3m2tlh0Civx8zThSghg%2BpueeQCXRpXovAvg0lNDbd7x%2FeHDqABBpsLMijG4TiV64pZvpLSad%2Bm4b4pqP8p0SxcsNo8wH%2FB39VsraWfQaGxP8W%2BqsHCW\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8666eaa3defddab1-MIA"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Tags were successfully attached! \"\n}"}],"_postman_id":"78e4c1ba-7bbd-43c8-becf-3d7705308635"},{"name":"Delete TAG","id":"6ee345cb-817b-45e2-9a2b-782da35ebd79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/files/tags?file_id=124472&tag_id[0]=6","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","tags"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][INT] ID do documento cujuas tags vão ser removidas.
\n","type":"text/plain"},"key":"file_id","value":"124472"},{"description":{"content":"[Obrigatório][Array] IDs das TAGS que serão removidas do documento.
\n","type":"text/plain"},"key":"tag_id[0]","value":"6"}],"variable":[]}},"response":[{"id":"fae797f3-5b47-4165-a417-dae993480e01","name":"Sucesso","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/files/tags?file_id=124472&tag_id[0]=6","protocol":"https","host":["app","plugsign","com","br"],"path":["api","files","tags"],"query":[{"key":"file_id","value":"124472","description":"[Obrigatório][INT] ID do documento cujuas tags vão ser removidas."},{"key":"tag_id[0]","value":"6","description":"[Obrigatório][Array] IDs das TAGS que serão removidas do documento."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:32:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=q%2Bft%2FTLj4b4jEVWu%2BOP%2FRLOORxK39Vh6zET83aHNYhNveLiWT2keQIr8XVKI18F4PVQpwuJM%2BSkwgtUikloAhmeqekEVaIl9XFspcQJ9XCuDMAY22vUDI%2BDPyzABSx4AwXVzYsnj\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8666f6937a807a08-GIG"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"ok\"\n}"}],"_postman_id":"6ee345cb-817b-45e2-9a2b-782da35ebd79"},{"name":"List document TAGS","id":"2c16bc93-11d3-4b65-945d-54f0a1cc6396","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/files/{{document_id}}/tags","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","{{document_id}}","tags"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"8665c0c9-4ce7-4e32-be35-a3ba73bd2980","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/files/124472/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:26:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=oP1YLrwgtiFWUuT3FEwLKHYvQRnLbuUeN9lTkE6YYj5mMpFmmTN1a3LhtmhYkSUmmUDn1cnUfiSOlzbNCvArjm%2BdEqUEuPdll9z%2Fyp4ujQ04iICDFEiP9H7gjyUsrmdifphLNO4z\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8666edc93954dab1-MIA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 5,\n \"name\": \"novo-nome\",\n \"created_at\": \"2024-03-18 14:17:47\"\n },\n {\n \"id\": 6,\n \"name\": \"minha-tag\",\n \"created_at\": \"2024-03-18 14:24:29\"\n }\n ]\n}"}],"_postman_id":"2c16bc93-11d3-4b65-945d-54f0a1cc6396"}],"id":"98b3dd4e-34d7-42de-ae90-b49672b6a3d5","_postman_id":"98b3dd4e-34d7-42de-ae90-b49672b6a3d5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Upload file","id":"fc80f8b3-59af-4cf6-af9a-730c94fc5880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"formdata","formdata":[{"key":"folder","value":"461","description":"[Opcional][Int] Pasta na qual o documento deve ficar, caso não seja informado ele irá ficar na pasta raíz da empresa.
\n","type":"text"},{"key":"name","value":"Meu documento importante!","description":"[Obrigatório][String] Nome único do documento para visualização no front-end.
\n","type":"text"},{"key":"file","description":"[Obrigatório][File/String Base64] Arquivo que está sendo enviado em PDF (File ou Base64), Word, Excel ou Power Point. (Para Base64 utilizar o formato data:application/pdf;base64)
\n","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","src":"/C:/Users/ADM/Desktop/modelo-doc-padrao.pdf"},{"key":"optimizer","value":"1","description":"[Opcional][bool] Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento
\n","type":"text"},{"key":"pass_owner","value":"1234","description":"[Opcional][String] Senha do propietário do documento com permissões totais.
\n","type":"text"},{"key":"pass_user","value":"1234","description":"[Opcional][String] Senha de acesso simples do documento.
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/files/upload","description":"Com este endpoint você poderá enviar um novo arquivo ao PlugSign, para futuramente enviar para uma ou mais pessoas assinarem e/ou preencherem o mesmo.
\nATENÇÃO! O envio do documento e dos templates possuem finalidades diferentes!
\nO upload de documentos é o envio simples de um arquivo, já o template precisa que no ato do envio, você defina seus campos de preenchimento e assinatura, para mais informações sobre os campos consulte a documentação dos templates ou de solicitações de assinaturas.
\nPara envio de documentos é necessário que o tipo da requisição seja um form-data!
\nPara enviar um documento para o PlugSign, você deverá passar alguns parâmetros conforme abaixo, porém destacamos aqui o parâmetro FILE.
\nEste parâmetro poderá ser de dois tipos:
\nConversão para PDF: Quando um documento for assinado ou uma solicitação de assinatura for realizada, a conversão de documentos Office para PDF será feita automaticamente.
\nAs informações do documento como document_key não são alteradas, porém dados como o endpoint para download, o formato e o tamanho do mesmo serão ajustados.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","upload"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"57e5cedb-9e26-4be3-82c5-f2196cc538e1","name":"Upload file","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"body":{"mode":"formdata","formdata":[{"key":"folder","value":"461","description":"[Opcional][Int] Pasta na qual o documento deve ficar, caso não seja informado ele irá ficar na pasta raíz da empresa.","type":"text"},{"key":"name","value":"Meu documento importante!","description":"[Obrigatório][String] Nome único do documento para visualização no front-end.","type":"text"},{"key":"file","description":"[Obrigatório][File/String Base64] Arquivo que está sendo enviado em PDF (File ou Base64), Word, Excel ou Power Point.","type":"file","src":"/C:/Users/ADM/Desktop/modelo-doc-plugsign.pdf"},{"key":"optimizer","value":"1","description":"[Opcional][bool] Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento","type":"text"}]},"url":"https://app.plugsign.com.br/api/files/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:46:38 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 3116,\n \"name\": \"Meu documento importante!\",\n \"file_name\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI.pdf\",\n \"extension\": \"pdf\",\n \"size\": 218297,\n \"status\": \"Unsigned\",\n \"document_key\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"editted\": \"No\",\n \"is_template\": \"No\",\n \"template_fields\": null,\n \"accessibility\": \"Only Me\",\n \"departments\": null,\n \"folder\": {\n \"id\": 461,\n \"folder\": \"Contratos de venda\",\n \"accessibility\": \"Only Me\",\n \"sub_folders\": [],\n \"created_on\": \"24/08/2022 10:44:24\"\n },\n \"uploaded_by\": {\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\"\n },\n \"uploaded_on\": \"24/08/2022 10:46:47\",\n \"download\": \"https://app.plugsign.com.br/api/files/download/S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\"\n },\n \"message\": \"Upload efetuado com sucesso!\"\n}"}],"_postman_id":"fc80f8b3-59af-4cf6-af9a-730c94fc5880"},{"name":"Get files","id":"ef3e2090-2a5a-4fdf-a295-50f360d4eff0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Contrato XYZ","description":"[Opcional][String] O nome do documento que é visível na pltaforma (Ex: Contrato de locação)
\n","type":"text"},{"key":"editted","value":"yes","description":"[Opcional][String: Yes, No] Marca se o documento já foi editado e/ou assinado ou se ainda é o doc original
\n","type":"text"},{"key":"document_key","value":"{{document_key}}","description":"[Opcional][String] A Document Key (Identificador único) do documento
\n","type":"text"},{"key":"is_template","value":"No","description":"[Opcional][String: Yes, No] Marca se o documento é um template ou um documento convencional
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/docs?name=Meu doc importante&file_name=eu8cOTP2CBcYZSUczUeTeZJmaN9FeGJr.pdf&editted=No&document_key=5tN7CeAodUfeN96sI60LcuxA9I7GlnNa&is_template=No&folder=591","description":"Filtro para o nome do documento como está na plataforma (Front-end).
\n","type":"text/plain"},"key":"name","value":"Meu doc importante"},{"description":{"content":"Nome do arquivo referente ao endpoint de download.
\n","type":"text/plain"},"key":"file_name","value":"eu8cOTP2CBcYZSUczUeTeZJmaN9FeGJr.pdf"},{"description":{"content":"Variante para buscar se o documento já foi editado/assinado ou não (Yes/No).
\n","type":"text/plain"},"key":"editted","value":"No"},{"description":{"content":"Chave primária do documento utilizada para controle via API.
\n","type":"text/plain"},"key":"document_key","value":"5tN7CeAodUfeN96sI60LcuxA9I7GlnNa"},{"description":{"content":"Variante para buscar por templates ou por documentos convencionais (Yes/No)
\n","type":"text/plain"},"key":"is_template","value":"No"},{"description":{"content":"[Opcional] ID da pasta para busca dos documentos
\n","type":"text/plain"},"key":"folder","value":"591"}],"variable":[]}},"response":[{"id":"3581dcdb-61aa-462e-a37b-97073c14fd11","name":"Get files","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Contrato XYZ","description":"[Opcional][String] O nome do documento que é visível na pltaforma (Ex: Contrato de locação)","type":"text"},{"key":"editted","value":"yes","description":"[Opcional][String: Yes, No] Marca se o documento já foi editado e/ou assinado ou se ainda é o doc original","type":"text"},{"key":"document_key","value":"{{document_key}}","description":"[Opcional][String] A Document Key (Identificador único) do documento","type":"text"},{"key":"is_template","value":"No","description":"[Opcional][String: Yes, No] Marca se o documento é um template ou um documento convencional","type":"text"}]},"url":{"raw":"https://app.plugsign.com.br/api/docs?document_key=5tN7CeAodUfeN96sI60LcuxA9I7GlnNa","protocol":"https","host":["app","plugsign","com","br"],"path":["api","docs"],"query":[{"key":"name","value":"Meu doc importante","description":"Filtro para o nome do documento como está na plataforma (Front-end).","disabled":true},{"key":"file_name","value":"eu8cOTP2CBcYZSUczUeTeZJmaN9FeGJr.pdf","description":"Nome do arquivo referente ao endpoint de download.","disabled":true},{"key":"editted","value":"No","description":"Variante para buscar se o documento já foi editado/assinado ou não (Yes/No).","disabled":true},{"key":"document_key","value":"5tN7CeAodUfeN96sI60LcuxA9I7GlnNa","description":"Chave primária do documento utilizada para controle via API."},{"key":"is_template","value":"No","description":"Variante para buscar por templates ou por documentos convencionais (Yes/No)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:47:55 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 3116,\n \"name\": \"Meu documento importante!\",\n \"file_name\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI.pdf\",\n \"extension\": \"pdf\",\n \"size\": 218297,\n \"status\": \"Unsigned\",\n \"document_key\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"editted\": \"No\",\n \"is_template\": \"No\",\n \"template_fields\": null,\n \"accessibility\": \"Only Me\",\n \"departments\": null,\n \"folder\": {\n \"id\": 461,\n \"folder\": \"Contratos de venda\",\n \"accessibility\": \"Only Me\",\n \"sub_folders\": [],\n \"created_on\": \"24/08/2022 10:44:24\"\n },\n \"uploaded_by\": {\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\"\n },\n \"uploaded_on\": \"24/08/2022 10:46:47\",\n \"download\": \"https://app.plugsign.com.br/api/files/download/S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/docs?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/docs?page=1\",\n \"prev\": null,\n \"next\": \"https://app.plugsign.com.br/api/docs?page=1\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/docs?page=1\",\n \"label\": \"1\",\n \"active\": true\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/docs\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"ef3e2090-2a5a-4fdf-a295-50f360d4eff0"},{"name":"Upload template","id":"3ace46e1-d94c-4bbb-91d7-a520a39d9132","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"formdata","formdata":[{"key":"folder","value":"273","type":"text","description":"[Obrigatório][Int] Pasta na qual o documento deve ficar, caso não seja passado ele irá ficar na pasta raíz da empresa.
\n"},{"key":"name","value":"Meu template importante","type":"text","description":"[Obrigatório][String] Nome único do documento na plataforma.
\n"},{"key":"file","type":"file","description":"[Obrigatório][File/Base64] Documento no formato FILE ou base64 e em PDF.
\n","src":"/C:/Users/ADM/Desktop/modelo-doc-plugsign.pdf"},{"key":"width_page","value":"958","description":"[Obrigatório][Float] Largura da página em pixels, este número será utilizado na hora de calcular as posições e campos de solicitação e/ou assinatura.
\n","type":"text"},{"key":"fields[0][xPos]","value":"147","description":"[Obrigatório ao menos um][Float] Posição X do campo no documento, baseado na dimensão que foi passada na largura da página
\n","type":"text"},{"key":"fields[0][yPos]","value":"942","description":"[Obrigatório ao menos um][Float] Posição Y do campo no documento, baseado na dimensão que foi passada na largura da página
\n","type":"text"},{"key":"fields[0][input]","value":"image","description":"[Obrigatório ao menos um][image/text] Tipo de campo solicitado, \"image\" para assinatura e \"text\" para texto.
\n","type":"text"},{"key":"fields[0][width]","value":"200","description":"[Obrigatório ao menos um][Float] Largura do campo a ser inserido no documento baseado na largura da página.
\n","type":"text"},{"key":"fields[0][height]","value":"100","description":"[Obrigatório ao menos um][Float] Altura do campo a ser inserido no documento baseado na largura da página.
\n","type":"text"},{"key":"fields[0][page]","value":"1","description":"[Obrigatório ao menos um][Int] Página na qual o campo será incluído.
\n","type":"text"},{"key":"fields[1][xPos]","value":"200","description":"[Obrigatório ao menos um][Float] Posição X do campo no documento, baseado na dimensão que foi passada na largura da página
\n","type":"text"},{"key":"fields[1][yPos]","value":"300","description":"[Obrigatório ao menos um][Float] Posição Y do campo no documento, baseado na dimensão que foi passada na largura da página
\n","type":"text"},{"key":"fields[1][input]","value":"text","description":"[Obrigatório ao menos um][image/text] Tipo de campo solicitado, \"image\" para assinatura e \"text\" para texto.
\n","type":"text"},{"key":"fields[1][width]","value":"200","description":"[Obrigatório ao menos um][Float] Largura do campo a ser inserido no documento baseado na largura da página.
\n","type":"text"},{"key":"fields[1][height]","value":"120","description":"[Obrigatório ao menos um][Float] Altura do campo a ser inserido no documento baseado na largura da página.
\n","type":"text"},{"key":"fields[1][page]","value":"1","description":"[Obrigatório ao menos um][Int] Página na qual o campo será incluído.
\n","type":"text"},{"key":"fields[1][color]","value":"#000000","description":"[Obrigatório][String] A cor do texto que será inserido no documento, utilizando o padrão RGB
\n","type":"text"},{"key":"fields[1][text]","value":"Nome completo","description":"[Obrigatório][Srtring] A label do campo que será solicitado ao usuário final, caso seja um termo padrão do PlugSing (Possível ver no front-end) o sistema vai validar os dados, como CPF, CNPJ, EMAIL e etc.
\n","type":"text"},{"key":"fields[1][align]","value":"center","description":"[Opcional][String right, left, center] O alinhamento do texto na caixa que será criada no documento
\n","type":"text"},{"key":"fields[1][bold]","value":"bold","description":"[Opcional][String bold] Se o texzto será em negrito
\n","type":"text"},{"key":"fields[1][italic]","value":"italic","description":"[Opcional][String italic] Se o texzto será em itálico
\n","type":"text"},{"key":"fields[1][fontsize]","value":"14","description":"[Obrigatório][Int] O tamanho da fonte do texto em pixels (Recomendado 14 para A4)
\n","type":"text"},{"key":"fields[1][underline]","value":"underline","description":"[Opcional][String underline] Se o texzto será grifado
\n","type":"text"},{"key":"fields[1][strikethrough]","value":"strikethrough","description":"[Opcional][String strikethrough] Se o texzto será tachado
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/files/upload/template","description":"Com este endpoint você poderá enviar um novo template ao PlugSign, para futuramente enviar solicitações de assinatura para várias pessoas de forma simplificada.
\nATENÇÃO! O envio do documento e dos templates possuem finalidades diferentes!
\nO upload de tempaltes conta com alguns campos do upload de documentos, como file, folder e name, porém possuí mais campos obrigatórios, os campos de preenchimento e assinatura!
\nConfira neste vídeo como os campos funcionam:
\nConfira um vídeo sobre o upload de templates: https://youtu.be/BV8Ak5i7_hw
\nPara envio de templates é necessário que o tipo da requisição seja um form-data!
\nPara enviar um template para o PlugSign, você deverá passar alguns parâmetros conforme abaixo:
\nConfira um vídeo sobre o upload de templates: https://youtu.be/BV8Ak5i7_hw
\nOs campos de preenchimento e assinatura em templates funcionam de forma similar aos campos na solicitação de assinatura com documentos convencionais.
\nPorém a facilidade de definir os mesmos com antecedência nos templates lhe permite automatizar o envio de documentos padronizados em lote, uma vez que a solicitação não vai precisar mais destas informações.
\nOs campos de preenchimento e assinatura são divididos em dois grupos, os de assinatura e os de preenchimento/informações.
\nO campo de assinatura permite que o signatário crie um assinatura em texto, upload ou desenhando e insira a mesma no documento.
\nEla também gera um registro de assinatura e criptografa o documento com um certificado digital para que o mesmo possa ser validado posteriormente.
\nEla também gera um relatório de assinaturas ao final do documento, criando uma ou mais páginas extras com os dados de todos os signatários.
\nPorém atenção! Este relatório só é gerado em caso de ASSINATURA, solicitar nome e outros dados não é contabilizado como assinatura em um documento.
\nDados necessários para a assinatura:
\nOs campos de dados permitem que você solicite dados do signatário e inclua eles no documento, finalizando o mesmo.
\nSão permitidos quaisquer tipos de informações, como nome, CPF, data de nascimento e etc, além de ser permitido criar novos tipos.
\nAlguns campos são similares aos de assinatura, porém este tipo de dado possuí campos exclusivos:
\nSeu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://app.plugsign.com.br/api/files/download/{{document_key}}","description":"O endpoint de download de arquivos é único, cada documento possuí um endpoint personalizado para o qual você deve fazer uma requisição, com seu token, para receber a versão mais recente do documento.
\nApós a chamada você receberá um retorno com o documento assinado e preenchido, se for o caso, para download.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","download","{{document_key}}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd3b0a5e-4f60-48f3-87ce-e9d37bdfe23d"},{"name":"Duplicate file","id":"93bebc82-95bd-46ea-b9e5-ce2a6956eb06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.plugsign.com.br/api/files/duplicate?document_key=5tN7CeAodUfeN96sI60LcuxA9I7GlnNa","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","duplicate"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[OIbrigatório] Document Key do documento que deve ser duplicado.
\n","type":"text/plain"},"key":"document_key","value":"5tN7CeAodUfeN96sI60LcuxA9I7GlnNa"}],"variable":[]}},"response":[],"_postman_id":"93bebc82-95bd-46ea-b9e5-ce2a6956eb06"},{"name":"Update file info","id":"ec2bff12-164e-4097-82b8-540d550d9ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Meu novo doc\",\r\n \"folder\": 123,\r\n \"accessibility\": \"Departments\",\r\n \"departments\": [38]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/docs/iGPB3qeO3HqAnazsDPVPkJXoaSqzfuID","description":"Este endpoint atualiza os dados do documento, é necessário passar ao menos um dos 4 parâmetros para que o mesmo execute corretamente.
\nCaso passe no parâmetro \"accessibility\" a opção \"Departments\", é obrigatório informar o parâmetro \"departments\" com um array com os departamentos desejados.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","docs","iGPB3qeO3HqAnazsDPVPkJXoaSqzfuID"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"862c7e26-f34f-4e26-9342-efc4ba86ea98","name":"Update file info response success","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/docs/{{document_key}}?name=Novo nome do doc!","protocol":"https","host":["app","plugsign","com","br"],"path":["api","docs","{{document_key}}"],"query":[{"key":"name","value":"Novo nome do doc!"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 28 Dec 2022 14:02:48 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Name updated\"\n}"},{"id":"b16f0aeb-fa63-43d3-9ce9-1b549869bb17","name":"Update file info response error","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/docs/{{document_key}}?name=Novo nome do doc!","protocol":"https","host":["app","plugsign","com","br"],"path":["api","docs","{{document_key}}"],"query":[{"key":"name","value":"Novo nome do doc!"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 28 Dec 2022 14:03:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"doc not found\"\n}"}],"_postman_id":"ec2bff12-164e-4097-82b8-540d550d9ef6"},{"name":"Delete file","id":"e012654c-b6a8-4da4-87a0-fef312415cd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/docs?id=2236","description":"O endpoint delete files permite que você apague um documento da plataforma PlugSign, esta ação é irreversível e tem alguns pontos de alerta!
\n[Obrigatório][Int] ID do documento no sistema, pode ser obtido no upload ou com o endpoint List Files
\n","type":"text/plain"},"key":"id","value":"2236"}],"variable":[]}},"response":[],"_postman_id":"e012654c-b6a8-4da4-87a0-fef312415cd8"},{"name":"Upload and send request","id":"94726a10-3eb2-4f32-bd02-98c7216c079d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 123456","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Meu doc importante!!!","description":"[Required][String] Nome do arquivo que será criado no assinadoc
\n","type":"text"},{"key":"file","description":"[Required][File / Base64] Arquivo PDF ou office como arquivo, para PDF é possível enviar um Base64
\n","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/ADM/Desktop/modelo-doc-plugsign.pdf"],"src":"/C:/Users/ADM/Desktop/modelo-doc-plugsign.pdf"},{"key":"message","value":"Assine o doc por favor","description":"[Required][String] Mensagem enviada para o destinatário.
\n","type":"text"},{"key":"email[0]","value":"contato@plugsign.com.br","description":"[Required][Array] E-mails e/ou Celulares com WhatsApp para envio, mínimo 1.
\n","type":"text"},{"key":"chain","value":"1","description":"[Optional][Bool] Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempo. O padrão é 1, ou seja, envio em cadeia.
\n","type":"text"},{"key":"optimizer","value":"1","description":"[Opcional][bool] Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento
\n","type":"text"},{"key":"image_selfie","value":"1","description":"[Optional][Bool] Se o usuário deverá enviar uma selfie para a página de validação.
\n","type":"text"},{"key":"image_doc","value":"1","description":"[Optional][Bool] Se o usuário deverá enviar uma foto do seu documento de identidade para a página de validação.
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/files/upload/requests","description":"Faz o upload de um documento (PDF ou Office) e envia para ser assinado por uma ou mais pessoas com assinatura na página de validação.
\nEste endpoint chama os endpoints de \"Upload File\" e \"Send Request With Document\", portanto as regras de validação de ambos se aplicam a ele.
\nPortanto é possível enviar documentos BASE64 (PDF) no padrão aceito em \"Upload File\" por exemplo, assim como o sistema vai converter documentos de office no ato da solicitação, como em \"Send Request With Document\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","upload","requests"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"95bd17e2-5407-40f6-b578-946274337264","name":"Upload and send request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 123456","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Meu doc importante!!!","description":"[Required][String] Nome do arquivo que será criado no assinadoc","type":"text"},{"key":"file","description":"[Required][File / Base64] Arquivo PDF ou office como arquivo, para PDF é possível enviar um Base64","type":"file","src":"/C:/Users/ADM/Desktop/modelo-doc-plugsign.pdf"},{"key":"message","value":"Assine o doc por favor","description":"[Required][String] Mensagem enviada para o destinatário.","type":"text"},{"key":"email[0]","value":"96981448003","description":"[Required][Array] E-mails e/ou Celulares com WhatsApp para envio, mínimo 1.","type":"text"},{"key":"chain","value":"0","description":"[Optional][Bool] Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempo.","type":"text"}]},"url":"https://app.assinadoc.com/api/files/upload/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 19:56:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=SWa7lzi8a3RVWeiGNJoBjes0EktOQ4f9lUVmpn%2B2AkDrumRajw%2BCvyLxgPHCgW5d9f15V5QLnFtVpcgv3qGEEX0JJzs1EZGD5%2BzGgVtGidV%2BUwgi2nzKuuNuVbspqaq8Ed%2FnWQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7be1632f3a9201be-GRU"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 219907,\n \"signing_key\": \"LKJHLKJHLKJHLKJHLKJHLKJH\",\n \"document\": \"POIUPOIUPOIUPOIUPOIUPOIU\",\n \"email\": \"contato@assinadoc.com\",\n \"message\": \"Assine o doc por favor\",\n \"sender\": {\n \"id\": 1111,\n \"name\": \"Maria\",\n \"last_name\": \"Santos\",\n \"email\": \"contato@plugsign.com.br\",\n \"permissions\": [\n \"edit\",\n \"delete\",\n \"upload\",\n \"send_request\",\n \"protect\"\n ]\n },\n \"expire_date\": null,\n \"send_time\": \"26/04/2023 16:56:10\",\n \"update_time\": \"26/04/2023 16:56:14\",\n \"creted_at\": \"26/04/2023 16:56:10\",\n \"status\": \"Pending\"\n }\n ],\n \"message\": \"Sua solicitação foi enviado com sucesso!\"\n}"}],"_postman_id":"94726a10-3eb2-4f32-bd02-98c7216c079d"},{"name":"Flatten file","id":"383662e4-29cb-4d92-880a-8fd9a3fc8cb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/optmizerpdf/{{document_key}}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","optmizerpdf","{{document_key}}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"383662e4-29cb-4d92-880a-8fd9a3fc8cb7"},{"name":"Protect File","id":"2a6c69bc-db8c-4fc3-a564-537bc109abdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Deixa explicito o retorno desejado.
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/files/protect?document_key=a0nxNykXbVk7H0MdcO4sk1Vt74cQGRza&pass_owner=1234&pass_user=1234","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","protect"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[OIbrigatório] Document Key do documento que será protegido por senha.
\n","type":"text/plain"},"key":"document_key","value":"a0nxNykXbVk7H0MdcO4sk1Vt74cQGRza"},{"description":{"content":"[Opcional][String] Senha do propietário do documento com permissões totais.
\n","type":"text/plain"},"key":"pass_owner","value":"1234"},{"description":{"content":"[Opcional][String] Senha de acesso simples do documento.
\n","type":"text/plain"},"key":"pass_user","value":"1234"}],"variable":[]}},"response":[],"_postman_id":"2a6c69bc-db8c-4fc3-a564-537bc109abdd"},{"name":"Sign file [BETA]","id":"0cf08426-ff2a-4167-91a1-87c9dd8cd614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Token de acesso da conta que vai realizar o processo
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Aceite de resposta da API
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/files/sign?document_key=DSAD76DSA7D6SA98D6SA9B6DSA98&user_id=123&page=1&xPos=100&yPos=100","description":"[BETA] Assina um documento via API com a conta de um dos usuários cadastrados.
\nEsta assinatura é indicada para usuários que possuam certificado digital cadastrado na paltaforma, neste caso o sistema irá utilizar o certificado da conta informada no processo de assinatura.
\nVocê pode incluir o certificado do usuário ao criar a conta dele via API, neste endpoint.
\nOpcionalmente, é possível atualizar uma conta existente, informando o certificado que será passado para tal conta através deste endpoint.
\nA assinatura via API é uma assinatura invisível, o sistema não vai inserir representações gráficas da assinatura no documento, apenas realizar a assinatura eletrônica que poderá ser validada posteriormente via ITI.
\nPara realizar o processo é necessário definir a página e a posição da assinatura visual, que vai conter os dados do signatário e do seu certificado.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","files","sign"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório] Document Key do arquivo que será assinado via API, deve ser da empresa para o qual o token foi enviado
\n","type":"text/plain"},"key":"document_key","value":"DSAD76DSA7D6SA98D6SA9B6DSA98"},{"description":{"content":"[Opcional] Usuário para assinar o documento, caso não seja informado o sistema vai assinar pelo administrador da empresa.
\n","type":"text/plain"},"key":"user_id","value":"123"},{"description":{"content":"[Obrigatório] Página na qual a assinatura será inserida.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"[Obrigatório] Posição no eixo X no documento onde a assinatura será inserida.
\n","type":"text/plain"},"key":"xPos","value":"100"},{"description":{"content":"[Obrigatório] Posição no eixo Y no documento onde a assinatura será inserida.
\n","type":"text/plain"},"key":"yPos","value":"100"}],"variable":[]}},"response":[],"_postman_id":"0cf08426-ff2a-4167-91a1-87c9dd8cd614"}],"id":"1b034f96-5b69-4e5b-a6ac-8c257dc38b67","description":"O envio de documentos para o PlugSign é o primeiro passo para assinar documentos, você precisará enviar documentos para poder manipular os mesmos.
\nO envio de documentos é dividido em dois tipos, os \"templates\" e os \"documents\", que são os documentos simples.
\nOs templates são modelos de documento que podem gerar novos documentos para envio rápido, eles são como esqueletos de documentos, com campos de preenchimento e/ou assinatura pré-definidos para que você possa solicitar dados de várias pessoas rapidamente.
\nO ideal é que utilize templates com documentos que são padronizados, como fichas de inscrição, termos de adesão e etc, documentos que não possuem dados customizados, a não ser os que o signatário irá fornecer.
\nO envio de solicitação de assinatura com o template sempre vai gerar novos documentos, tornando o processo de envio de solicitações mais ágil, portanto se enviar uma solicitação de assinatura com um template para 5 pessoas, o PlugSign irá gerar 5 cópias do template e enviar as mesmas para os signatários individualmente.
\nAtenção! Para enviar um template para o PlugSign é necessário fornecer os campos de preenchimento e assinatura de froma antecipada, o que não é obrigatório nos documentos comuns.
\nOs documentos convencionais são, como o nome já diz, documentos comuns, que você pode enviar para o PlugSign e enviar para pessoas assinarem.
\nCom os documentos convencionais é possível pedir para uma ou mais pessoas assinarem o mesmo documento (E mesmo arquivo digital), como um contrato que possuí 4 signatários, onde os 4 precisam assinar o mesmo documento.
\nVocê poderá tanto solicitar os dados dos signatários individualmente, ou se preferir enviar o documento preenchido que foi gerado pelo seu sistema e solicitar apenas assinaturas.
\nÉ possível enviar documentos em PDF (Arquivo ou Base64), Word, Excel ou Power Point para o PlugSign, porém vale ressaltar que no ato da assinatura ou solicitação de assinatura, será necessário converter ele para PDF, mas não esquenta! O PlugSign faz isso automaticamente para você!
\n","_postman_id":"1b034f96-5b69-4e5b-a6ac-8c257dc38b67","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Requests","item":[{"name":"Send request with document","id":"7f089896-6add-4c0d-8493-af15023de8d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"raw","raw":"{\r\n \"document_key\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\r\n \"email\": [\r\n \"contato@plugsign.com.br\",\r\n \"11988557744\"\r\n ],\r\n \"subject\": \"Segue o documento para assinatura!\",\r\n \"message\": \"Mensagem de envio de documento para assinaturaPor este endpoint é possível enviar solicitações de assinatura em documentos, o processo pode ser feito para vários e-mails, lembrando que todos os signatários vão assinar o mesmo documento (Mesmo arquivo).
\nConfira em detalhes os campos que devem ser preenchidos e suas particularidades:
\nConfira abaixo um vídeo falando mais sobre os posicionamentos dos campos e sobre os dados necessários neste endpoint para solicitar assinaturas e informações.
\nComo enviar solicitações e definir campos: https://youtu.be/GdUDlvXP4Uw?t=392
\nAtravés da chamada é possível pedir a assinatura do usuário sem definir as posições nos eixos X e Y como de costume.
\nPara isto é recomendado que você solicite apenas a assinatura do destinatário, não solicitando outras informações em conjunto.
\nÉ possível solicitar mais dados, porém por se tratar de uma funcionalidade em beta, existe esta recomendação.
\nQuando solicitamos uma assinatura sem definir o local, a mesma vai ser inserida na página extra gerada após o documento, nela serão inseridos todos os dados do usuário, assim como a sua assinatura gerada no ato da mesma, como é possível ver abaixo.
\nÉ importante ressaltar que, como é possível solicitar assinaturas para convidados, o PlugSign não grava os dados nem a assinatura deste signatário, portanto é necessário gerar uma página para cada pessoa.
\nPortanto, se o documento tiver 4 signatários que vão assinar neste mesmo formato, o documento irá ter 4 páginas extras, uma com a assinatura de cada pessoa.
\nPara enviar uma solicitação sem local, basta fazer o envio normalmente, e no campo de solicitação que seria enviado, definir os locais X e Y como -999 (Necessário ser exatamente este número), como é possível var abaixo:
\n{ \"page\": 1, \"type\": \"image\", \"width\": 200, \"height\": 75, \"xPos\": -999, \"yPos\": -999 }
Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"document_key\": \"q8B8Brh3PMPA4yfO4EDvsnhaE9061AvO\",\r\n \"message\": \"Assine o documento por favor...\",\r\n \"subject\": \"Segue o documento para assinatura!\",\r\n \"image_selfie\": 1,\r\n \"image_doc\": 1,\r\n \"email\": [\r\n \"felipe.s.ladislau@gmail.com\"\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/requests/templates","description":"O envio de solicitação de assinatura com templates é mais simples que o envio com documentos, uma vez que não é necessário definir os campos (Pois já foram definidos no upload).
\nPorém é importante se atentar a algo importante, o envio com templates é INDIVIDUAL, portanto se passar 3 e-mails no array \"emails\", o sistema vai gerar 3 documentos únicos e enviar um para cada e-mail, de forma que cada signatário vai assinar um documento único.
\nLembre-se também que o template original NÃO VAI SER ASSINADO, e sim suas cópias que vão ser geradas com base no modelo original.
\nSelfie (image_selfie): Se o signatário deverá enviar uma selfie para a página de validação, neste caso a solicitação será feita SEM LOCAL DEFINIDO, somente pedindo a assinatura do usuário, esta e a foto vão ser inseridos na página final de validação do documento.
\nDocumento (image_doc): Se o signatário deverá enviar uma foto do documento de identidade para a página de validação, neste caso a solicitação será feita SEM LOCAL DEFINIDO, somente pedindo a assinatura do usuário, esta e a foto vão ser inseridos na página final de validação do documento.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","requests","templates"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"230240de-cd8a-47d4-b1a6-4f0f24d4e06d","name":"Send request with template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"document_key\": \"q8B8Brh3PMPA4yfO4EDvsnhaE9061AvO\",\r\n \"message\": \"Assine o documento por favor...\",\r\n \"email\": [\r\n \"felipe.s.ladislau@gmail.com\"\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/requests/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:52:38 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 5127,\n \"signing_key\": \"Sgo0nNx5wt7abQCSbZffvS36r2aKiMOb\",\n \"document\": \"Djzjd6rWeOJCyGy4sixmwdfbiLI6vIdS\",\n \"email\": \"felipe.s.ladislau@gmail.com\",\n \"message\": \"Assine o documento por favor...\",\n \"sender\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"email\": \"felipe@assinadoc.com\",\n \"permissions\": [\n \"edit\",\n \"delete\",\n \"upload\",\n \"send_request\",\n \"protect\"\n ]\n },\n \"positions\": \"[\\\"958\\\",{\\\"xPos\\\":\\\"147\\\",\\\"yPos\\\":\\\"942\\\",\\\"input\\\":\\\"image\\\",\\\"width\\\":\\\"200\\\",\\\"height\\\":\\\"100\\\",\\\"page\\\":\\\"1\\\"},{\\\"xPos\\\":\\\"200\\\",\\\"yPos\\\":\\\"300\\\",\\\"input\\\":\\\"text\\\",\\\"width\\\":\\\"200\\\",\\\"height\\\":\\\"120\\\",\\\"page\\\":\\\"1\\\",\\\"color\\\":\\\"#000000\\\",\\\"text\\\":\\\"Nome completo\\\",\\\"align\\\":\\\"center\\\",\\\"bold\\\":\\\"bold\\\",\\\"italic\\\":\\\"italic\\\",\\\"fontsize\\\":\\\"14\\\",\\\"underline\\\":\\\"underline\\\",\\\"strikethrough\\\":\\\"strikethrough\\\"}]\",\n \"chain_emails\": null,\n \"chain_positions\": null,\n \"expire_date\": null,\n \"send_time\": \"24/08/2022 10:52:38\",\n \"update_time\": \"24/08/2022 10:52:42\",\n \"creted_at\": \"24/08/2022 10:52:38\",\n \"status\": \"Pending\"\n },\n \"message\": \"Sua solicitação foi enviada com sucesso!\"\n}"}],"_postman_id":"1e94cf45-a134-41ee-af14-950ccef9ffe4"},{"name":"Get requests","id":"f5481c3a-0e99-4bba-99ba-ed0e4364f715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/requests?email=contato@teste.com.br&signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4&document=rw38ENUSm6zhW5GYh5yTUvUeZoExsB3f&status=Signed","description":"Através deste endpoint você pode obter os dados das solicitações já enviadas para assinatura, vamos destacar aqui alguns campos importantes para análise:
\n[Opcional][String] Endereço de e-mail do signatário, para obter todos os envios para uma pessoa específica
\n","type":"text/plain"},"key":"email","value":"contato@teste.com.br"},{"description":{"content":"[Opcional][String] Chave da solicitação de assinatura, para filtrar e obter apenas uma solicitação específica
\n","type":"text/plain"},"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4"},{"description":{"content":"[Opcional][String] Document Key do documento, para obter todas as solicitações feitas para um doc específico
\n","type":"text/plain"},"key":"document","value":"rw38ENUSm6zhW5GYh5yTUvUeZoExsB3f"},{"description":{"content":"[Opcional][String Pending, Signed, Declined, Cancelled] Status da solicitação de assinatura
\n","type":"text/plain"},"key":"status","value":"Signed"}],"variable":[]}},"response":[{"id":"0dc62a6e-51a6-402c-b91b-0b429f228a33","name":"Get requests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/requests?email=contato@teste.com.br&signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","protocol":"https","host":["app","plugsign","com","br"],"path":["api","requests"],"query":[{"key":"email","value":"contato@teste.com.br","description":"[Opcional][String] Endereço de e-mail do signatário, para obter todos os envios para uma pessoa específica"},{"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","description":"[Opcional][String] Chave da solicitação de assinatura, para filtrar e obter apenas uma solicitação específica"},{"key":"document","value":"rw38ENUSm6zhW5GYh5yTUvUeZoExsB3f","description":"[Opcional][String] Document Key do documento, para obter todas as solicitações feitas para um doc específico","disabled":true},{"key":"status","value":"Signed","description":"[Opcional][String Pending, Signed, Declined, Cancelled] Status da solicitação de assinatura","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:52:12 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 5126,\n \"signing_key\": \"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4\",\n \"document\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"email\": \"felipe@assinadoc.com\",\n \"message\": \"Mensagem de envio de documento para assinatura\",\n \"sender\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"email\": \"felipe@assinadoc.com\",\n \"permissions\": [\n \"edit\",\n \"delete\",\n \"upload\",\n \"send_request\",\n \"protect\"\n ]\n },\n \"positions\": \"[\\\"1000\\\",{\\\"page\\\":1,\\\"type\\\":\\\"image\\\",\\\"width\\\":200,\\\"height\\\":75,\\\"xPos\\\":100,\\\"yPos\\\":100,\\\"fontsize\\\":\\\"\\\",\\\"group\\\":\\\"input\\\"},{\\\"page\\\":1,\\\"type\\\":\\\"text\\\",\\\"width\\\":200,\\\"height\\\":120,\\\"xPos\\\":200,\\\"yPos\\\":120,\\\"text\\\":\\\"Nome completo\\\",\\\"color\\\":\\\"#000000\\\",\\\"fontsize\\\":14,\\\"bold\\\":\\\"bold\\\",\\\"align\\\":\\\"left\\\",\\\"italic\\\":\\\"italic\\\",\\\"underline\\\":\\\"underline\\\",\\\"strikethrough\\\":\\\"strikethrough\\\",\\\"font\\\":\\\"lato\\\",\\\"fontfamily\\\":\\\"Lato, sans-serif\\\",\\\"group\\\":\\\"input\\\"}]\",\n \"chain_emails\": \"[\\\"contato@assinadoc.com\\\"]\",\n \"chain_positions\": \"[[\\\"1000\\\",{\\\"page\\\":1,\\\"type\\\":\\\"image\\\",\\\"width\\\":300,\\\"height\\\":75,\\\"xPos\\\":0,\\\"yPos\\\":0,\\\"fontsize\\\":\\\"\\\",\\\"group\\\":\\\"input\\\"}]]\",\n \"expire_date\": \"20/10/2022 10:10:10\",\n \"send_time\": \"24/08/2022 10:51:06\",\n \"update_time\": \"24/08/2022 10:52:12\",\n \"creted_at\": \"24/08/2022 10:51:06\",\n \"status\": \"Pending\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/requests?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/requests?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/requests?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/requests\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"f5481c3a-0e99-4bba-99ba-ed0e4364f715"},{"name":"Get single request data","id":"1f8502a4-5b44-4c28-9635-dd285d444165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/requests/{{signing_key}}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","requests","{{signing_key}}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f8502a4-5b44-4c28-9635-dd285d444165"},{"name":"Cancell Request","id":"8a864a0c-1355-4401-b3a2-b1e5641ca87e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/requests/cancelled?signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","description":"Através deste endpoint é possível cancelar uma solicitação de assinatura, caso o faça, o signatário não vai mais conseguir responder a mesma com o link que recebeu no seu e-mail.
\nCaso o mesmo não tenha acesso ao documento (Ele não seja público), o mesmo também não vai conseguir visualizar o doc.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","requests","cancelled"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] A chave única da soliucitação de assinatura que deverá ser cancelada
\n","type":"text/plain"},"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4"}],"variable":[]}},"response":[{"id":"6ed914d3-13a6-46ea-a676-050a02d38d86","name":"Cancell Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/requests/cancelled?signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","protocol":"https","host":["app","plugsign","com","br"],"path":["api","requests","cancelled"],"query":[{"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","description":"[Obrigatório][String] A chave única da soliucitação de assinatura que deverá ser cancelada"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:00 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request Cancelled\"\n}"}],"_postman_id":"8a864a0c-1355-4401-b3a2-b1e5641ca87e"}],"id":"28d6cafe-adfe-4c8f-98e1-1e25e458d23e","description":"O envio de solicitação de assinatura para signatários pode ser feito através de dois endpoints, o \"Send request with Document\" e o \"Send request with Template\", é importante se atentar que, assim como no upload, você pode fazer o processo com um documento convencional OU com um template de documento.
\nAo realizar o envio de solicitação com um template, o sistema vai automaticamente gerar cópias do template original como documentos e enviar para os signatários, portanto um template pode gerar X documentos, mas um documento nunca gera um template, de forma que a assinatura é sempre feita em um documento.
\nEntenda o template como um esqueleto de documento, através dele podemos gerar documentos em lote e enviar para várias pessoas ao mesmo tempo, economizando tempo.
\nConfira abaixo as principais diferenças dos dois casos e em qual caso cada um é recomendado:
\nO envio de solicitações com documentos é utilizado em 90% dos casos, ele é utilizado para documentos específicos que possuem conteúdo personalizado para o signatário atual, como um contrato que já contém os dados da pessoa ou uma proposta que foi gerada de forma personalizada.
\nCom este endpoint você deverá passar todos os locais de assinatura e/ou preenchimento no ato do envio, diferente do template que fica com os dados pré definidos.
\nJá o envio com template é recomendado para documentos que são padronizados, que vão mudar apenas os dados que devem ser preenchidos, como:
\nCom o template, você define todos os campos de preenchimento e assinatura NO UPLOAD DO TEMPLATE, assim quando for realizar o envio, o PlugSign vai recuperar estas informações e utiliza-las no envio.
\nApós o envio de um template para assinatura, o PlugSign vai gerar documentos na pasta raiz, com o nome do template e o e-mail para o qual foi enviado. Ex: MEU TEMPLATE (CONTATO@TESTE.COM.BR)
\n","_postman_id":"28d6cafe-adfe-4c8f-98e1-1e25e458d23e","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Reminders","item":[{"name":"Manual reminders","item":[{"name":"Reminder with WhatsApp","id":"83d3a45a-1c7d-4854-a06e-1d51f4e8a721","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"url":"https://app.plugsign.com.br/api/reminders/whatsapp?signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4&phone=96981448003&message=Mensagem para o cliente sobre a assinatura","description":"Através deste endpoint é possível enviar o link de assinatura para um telefone via WhatsApp, o envio é feito pelo número e assistente virtual do PlugSign de forma automática, sem gerar custos adicionais no seu plano.
\nÉ importante que passe o número no seguinte formato: DDD + 9 + NÚMERO DE TELEFONE (Ex: 11988443377) e que o mesmo possua WhatsApp ativo.
\nO envio da mensagem gera um registro que pode ser visualizado no front-end, na área \"Minhas solicitações\", assim como é possível ver o status da mensagem.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","reminders","whatsapp"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Chave da solicitação que deve ser lembrada
\n","type":"text/plain"},"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4"},{"description":{"content":"[Obrigatório][Int] Número de telefone com WhatsApp, sendo o DDD 9 e o número
\n","type":"text/plain"},"key":"phone","value":"96981448003"},{"description":{"content":"[Opcional][String] Mensagem para seu cliente sobre a solicitação, caso não informe será enviada uma mensagem padrão do sistema.
\n","type":"text/plain"},"key":"message","value":"Mensagem para o cliente sobre a assinatura"}],"variable":[]}},"response":[{"id":"2bcec9c1-f90f-400c-bf32-73e680ae747f","name":"Reminder with WhatsApp","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"url":{"raw":"https://app.plugsign.com.br/api/reminders/whatsapp?signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4&phone=96981448003","protocol":"https","host":["app","plugsign","com","br"],"path":["api","reminders","whatsapp"],"query":[{"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","description":"[Obrigatório][String] Chave da solicitação que deve ser lembrada"},{"key":"phone","value":"96981448003","description":"[Obrigatório][Int] Número de telefone com WhatsApp, sendo o DDD 9 e o número"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:51:28 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lembrete por WhatsApp enviado com sucesso!\"\n}"}],"_postman_id":"83d3a45a-1c7d-4854-a06e-1d51f4e8a721"},{"name":"Reminder with e-mail","id":"2b5c89d7-07d9-43c2-b3a9-13e7ee4844ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"url":"https://app.plugsign.com.br/api/reminders/email?signing_key=BAr2i8GDfM8LNXo626YEo70PkqSwqhke&message=Olá, assine o doc por favor!&subject=Assunto do e-mail","description":"Este endpoint reenvia o e-mail de solicitação, por isto não é necessário fornecer o endereço de e-mail novamente, pois o envio será feito para o e-mail da solicitação original.
\nBasta fornecer uma mensagem que será inserida no e-mail e a chave única da solicitação.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","reminders","email"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Chave da solicitação que deve ser lembrada
\n","type":"text/plain"},"key":"signing_key","value":"BAr2i8GDfM8LNXo626YEo70PkqSwqhke"},{"description":{"content":"[Obrigatório][String] Mensagem que deve ser enviada no e-mail para o usuário
\n","type":"text/plain"},"key":"message","value":"Olá, assine o doc por favor!"},{"description":{"content":"[Opcional][String] Assunto do e-mail enviado, caso não preencha vai enviar com o assunto padrão.
\n","type":"text/plain"},"key":"subject","value":"Assunto do e-mail"}],"variable":[]}},"response":[{"id":"f7c7dfd2-f16b-4a17-92a6-ff7be79d1363","name":"Reminder with e-mail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"url":{"raw":"https://app.plugsign.com.br/api/reminders/email?signing_key=vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4&message=Olá, assine o doc por favor!","protocol":"https","host":["app","plugsign","com","br"],"path":["api","reminders","email"],"query":[{"key":"signing_key","value":"vWNgu7z9MBVe2OLmUuKP152AHCQ1bxQ4","description":"[Obrigatório][String] Chave da solicitação que deve ser lembrada"},{"key":"message","value":"Olá, assine o doc por favor!","description":"[Obrigatório][String] Mensagem que deve ser enviada no e-mail para o usuário"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:51:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Lembrete enviado com sucesso.\"\n}"}],"_postman_id":"2b5c89d7-07d9-43c2-b3a9-13e7ee4844ff"}],"id":"f90a8546-d46d-41c6-bcd1-e5b819fe0731","_postman_id":"f90a8546-d46d-41c6-bcd1-e5b819fe0731","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Automated reminders","item":[{"name":"Get reminders","id":"27751855-59a4-4d79-a5f3-187add5b3550","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON
\n","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/reminders/automated","description":"Com este endpoint é possível listar todos os lembretes automáticos configurados no sistema para a conta atual (Sempre em nível de empresa).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","reminders","automated"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"ac73a1c3-a8e8-4a4f-a9a6-e632a82a03ce","name":"Get reminders","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API","type":"text"}],"url":"https://app.plugsign.com.br/api/reminders/automated"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Aug 2023 17:56:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=tT%2BM3dmEtYpOuyyPMYUSeyVJa6zcVnPWfS%2FZzQbBsJz06E4AA%2BMLOMdEYH4SpcT2lYP79GYzBAOzDy%2BnlS9ozhY4dfeMTYgtdXH5f9ahfJBPdYVLHpqvQdytqX%2FANQGQKgJuKNn6\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7feee9555837a790-EZE"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 125,\n \"subject\": \"Não se esqueça do seu documento!\",\n \"message\": \"Olá, tudo bem?\\r\\n\\r\\nGostaria de te lembrar que você ainda não assinou o documento, clique o link abaixo para assina-lo.\\r\\n\\r\\nAbraços, Felipe.\",\n \"days\": 1\n }\n ]\n}"}],"_postman_id":"27751855-59a4-4d79-a5f3-187add5b3550"},{"name":"Create reminder","id":"8dbef38a-76ba-4c4e-81f7-9d8bc1f50f5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON
\n","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/reminders/automated?subject=Lembrete de assinatura&message=Assine o documento por favor&days=3","description":"Crie lembretes automáticos para lembrar os signatários de solicitações pendentes.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","reminders","automated"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Assunto do e-mail de lembrete.
\n","type":"text/plain"},"key":"subject","value":"Lembrete de assinatura"},{"description":{"content":"[Obrigatório][String] Mensagem enviada no e-mail de solicitação.
\n","type":"text/plain"},"key":"message","value":"Assine o documento por favor"},{"description":{"content":"[Obrigatório][INT] Dias de vencida a solicitação.
\n","type":"text/plain"},"key":"days","value":"3"}],"variable":[]}},"response":[{"id":"ad9523d5-f6f6-45f3-9de0-50cd40481a18","name":"Create reminder","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/reminders/automated?subject=Lembrete de assinatura&message=Assine o documento por favor&days=3","protocol":"https","host":["app","plugsign","com","br"],"path":["api","reminders","automated"],"query":[{"key":"subject","value":"Lembrete de assinatura","description":"[Obrigatório][String] Assunto do e-mail de lembrete."},{"key":"message","value":"Assine o documento por favor","description":"[Obrigatório][String] Mensagem enviada no e-mail de solicitação."},{"key":"days","value":"3","description":"[Obrigatório][INT] Dias de vencida a solicitação."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Aug 2023 17:54:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"34"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=lYuXK0GOgIKI5gAygcI1bg1S0e%2FTQYNA254jN%2FIBuM3HX5g7WgNgoRz7I1WHqBHamiTKN675QiONKPIsSNo9%2B6CQAErkzBIO7EycC0E3Qj%2FCBBOOXze08jRzB7ctNZzvy46AkrM4\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7feee5fa8ad8a790-EZE"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 250,\n \"subject\": \"Lembrete de assinatura\",\n \"message\": \"Assine o documento por favor\",\n \"days\": \"3\"\n }\n}"}],"_postman_id":"8dbef38a-76ba-4c4e-81f7-9d8bc1f50f5b"},{"name":"Update reminder","id":"9d1443a0-53ff-4b4b-a052-9b1fdf3411e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON
\n","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/reminders/automated/250?subject=Lembrete de assinatura&message=Assine o documento por favor&days=5","description":"Atualize um lembrete automático criado anteriormente pelo endpoint de POST.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","reminders","automated","250"],"host":["app","plugsign","com","br"],"query":[{"key":"subject","value":"Lembrete de assinatura"},{"key":"message","value":"Assine o documento por favor"},{"key":"days","value":"5"}],"variable":[]}},"response":[{"id":"e55dd7d1-542c-4c23-97e4-a7fe7fdff7a5","name":"Update reminder","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/reminders/automated/250?subject=Lembrete de assinatura&message=Assine o documento por favor&days=5","protocol":"https","host":["app","plugsign","com","br"],"path":["api","reminders","automated","250"],"query":[{"key":"subject","value":"Lembrete de assinatura"},{"key":"message","value":"Assine o documento por favor"},{"key":"days","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Aug 2023 17:55:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"43"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=yC1J0TQH4Kog2ANDQFZSQ3bhe1oFSzri6TSsCODsEhkd18LahKTT%2FEia16%2BYqWm2cU%2Fc%2B2hewT1ZSFeOlMNO9jefNstXqHkl2At7I5JWJuo4LfnHNaoNOIPqDvKvuilO3GZAAJ0H\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7feee83a1ef5a790-EZE"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 250,\n \"company\": 1,\n \"subject\": \"Lembrete de assinatura\",\n \"days\": \"5\",\n \"message\": \"Assine o documento por favor\"\n}"}],"_postman_id":"9d1443a0-53ff-4b4b-a052-9b1fdf3411e8"},{"name":"Delete reminder","id":"d1d93c30-d31a-461e-b38d-44cd4245017a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON
\n","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/reminders/automated/250","description":"Apague um lembrete automático criado pelo front-end ou pelo método POST.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","reminders","automated","250"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"4e80bd02-58f4-4cc1-b258-dce4015805e7","name":"Delete reminder","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","description":"Padrão de retorno para resultados formatados em JSON","type":"text"},{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso da API","type":"text"}],"url":"https://app.plugsign.com.br/api/reminders/automated/125"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Aug 2023 18:04:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=KicjGlw2oCcJPBgC%2BMjXtalIWpn2Sh5B1Im%2FYhP0lxAD4AOAkQK3lFfJJOzzd8%2FKiOvtat09%2FYLvzPJk6uceiTr%2BFyGfDN4GLHG77OvhxFc%2Fofj4RoMijpbMY7c4Wq1X2ssM6B7Q\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7feef43aca6e0319-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Deleted reminder\"\n}"}],"_postman_id":"d1d93c30-d31a-461e-b38d-44cd4245017a"}],"id":"c333c304-9a8a-483f-9743-ccc3f3166538","description":"Com estes endpoints é possível criar, editar e deletar lembretes automáticos.
\nOs lembretes automáticos seguem uma regra de dias de vencimento, o sistema considera que a partir do momento em que a solicitação é enviada, se não for assinada no mesmo dia está atrasada.
\nOs lembretes são enviados de forma diária, entre meia noite e 05:00 da manhã, seguindo a regra de dias de vencimento definida.
\nCrie quantos lembretes precisar, lembretes com dias repetidos serão enviados de forma duplicada.
\n","_postman_id":"c333c304-9a8a-483f-9743-ccc3f3166538","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}}],"id":"28418eb5-1399-4edc-885e-fc9f680b0137","description":"Com os lembretes você pode reenviar o link de assinatura de forma rápida para o signatário do documento, via WhatsApp, SMS ou e-mail.
\nPorém vale ressaltar que o envio para celulares deve ser feito ÚNICA E EXCLUSIVAMENTE para o telefone do signatário, e que o número fica registrado no histórico do documento.
\n","_postman_id":"28418eb5-1399-4edc-885e-fc9f680b0137","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"History","item":[{"name":"Get file history","id":"366e8609-a6f4-4c12-8af1-60e9560ba08e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/histories/{{document_key}}","description":"Com este endpoint você pode obter o histórico de um documento, este normalmente inicia quando o doc é enviado para a plataforma, e finaliza quando o mesmo é assinado.
\nCom este histórico você pode obter todas as informações do documento, como quando ele foi editado, se um e-mail de solicitação foi aberto, se o documento foi baixado por um visitante e etc.
\nO histórico é composto da data e hora da atividade, no horário de Brasília, da mensagem que diz o que ocorreu com o mesmo, do usuário e empresa responsável pela ação (Caso estejam vazios, significa que a ação foi executada por um convidado, ou seja, um usuário sem cadastro no sistema) e do tipo de atividade.
\nO tipo de atividade por ser um de 3 tipos, sendo default o padrão para atividades simples, success para conclusões de assinatura e danger para alertas de ações, como ativação de proteção e recusa de assinatura.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","histories","{{document_key}}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"8b2182c5-1869-4a5a-a441-1a9d3edf2d50","name":"Get file history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":"https://app.plugsign.com.br/api/histories/{{document_key}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 31513,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Felipe Ladislau [170.79.193.78] enviou um lembrete de assinatura para felipe@assinadoc.com.\",\n \"time\": \"24/08/2022 10:51:55\",\n \"type\": \"default\"\n },\n {\n \"id\": 31512,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Felipe Ladislau [170.79.193.78] enviou um lembrete de assinatura para 96981147369 via SMS.\",\n \"time\": \"24/08/2022 10:51:42\",\n \"type\": \"default\"\n },\n {\n \"id\": 31511,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Felipe Ladislau [170.79.193.78] enviou um lembrete de assinatura para 96981448003 via WhatsApp.\",\n \"time\": \"24/08/2022 10:51:29\",\n \"type\": \"default\"\n },\n {\n \"id\": 31510,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Solicitação de assinatura enviada para , felipe@assinadoc.com por Felipe [170.79.193.78].\",\n \"time\": \"24/08/2022 10:51:09\",\n \"type\": \"default\"\n },\n {\n \"id\": 31508,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Arquivo enviado por Felipe Ladislau\",\n \"time\": \"24/08/2022 10:46:47\",\n \"type\": \"default\"\n }\n ]\n}"}],"_postman_id":"366e8609-a6f4-4c12-8af1-60e9560ba08e"},{"name":"Get file legacy history","id":"f6b6d310-6558-425e-902d-9fcf3ae16e95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/histories/legacy/{{document_key}}","description":"Este endpoint é similar ao \"GET HISTORY\", porém ele obtem o \"Histórico legado\", que é mantido de forma permanente, portanto mesmo que o documento tenha sido deletado, o histórico pode ser consultado.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","histories","legacy","{{document_key}}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"9614b561-e7c2-4614-a779-968067e1b24e","name":"Get file history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":"https://app.plugsign.com.br/api/histories/{{document_key}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 31513,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Felipe Ladislau [170.79.193.78] enviou um lembrete de assinatura para felipe@assinadoc.com.\",\n \"time\": \"24/08/2022 10:51:55\",\n \"type\": \"default\"\n },\n {\n \"id\": 31512,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Felipe Ladislau [170.79.193.78] enviou um lembrete de assinatura para 96981147369 via SMS.\",\n \"time\": \"24/08/2022 10:51:42\",\n \"type\": \"default\"\n },\n {\n \"id\": 31511,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Felipe Ladislau [170.79.193.78] enviou um lembrete de assinatura para 96981448003 via WhatsApp.\",\n \"time\": \"24/08/2022 10:51:29\",\n \"type\": \"default\"\n },\n {\n \"id\": 31510,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Solicitação de assinatura enviada para , felipe@assinadoc.com por Felipe [170.79.193.78].\",\n \"time\": \"24/08/2022 10:51:09\",\n \"type\": \"default\"\n },\n {\n \"id\": 31508,\n \"company\": 11,\n \"user\": {\n \"id\": 21,\n \"name\": \"Felipe\",\n \"last_name\": \"Ladislau\",\n \"phone\": \"96-98144-8003\",\n \"address\": \"Macapá\",\n \"email\": \"felipe@assinadoc.com\"\n },\n \"file\": \"S0idsZwbtNcpfcFDGgYcw2GXblUGDpOI\",\n \"activity\": \"Arquivo enviado por Felipe Ladislau\",\n \"time\": \"24/08/2022 10:46:47\",\n \"type\": \"default\"\n }\n ]\n}"}],"_postman_id":"f6b6d310-6558-425e-902d-9fcf3ae16e95"}],"id":"9cbc07cb-47aa-47c8-9748-da578de07c89","description":"O histórico te permite recuperar dados sobre um documento, informações sobre quando ele foi enviado, editado, baixado, assinado e etc.
\nEste mesmo histórico pode ser visualizado pelo front-end, na barra lateral direita do documento.
\n","_postman_id":"9cbc07cb-47aa-47c8-9748-da578de07c89","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Companies (Para revendedores)","item":[{"name":"Create company","id":"e0117213-8cb4-4605-9b5f-0073d4a598e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/companies?name=Guilherme&last_name=Santos&company_name=Empresa XYZ&email=guilherme@teste.com.br&cnpj=11.000.333/0001-29&address=Rua dos anjos, 123, Centro, São Paulo&phone=96981448003&password=123456&status=Inactive&recive_whatsapp=0&recive_email=0","description":"Com este endpoint você pode criar uma conta para uma empresa cliente e manipular a mesma com o seu respectivo token.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"Atente-se ao limite de carácteres!
\n
[Obrigatório][String] Primeiro nome do administrador da empresa (Limite de 80 caráctere)
\n","type":"text/plain"},"key":"name","value":"Guilherme"},{"description":{"content":"[Obrigatório][String] Sobrenome do administrador da empresa (Limite de 80 caráctere)
\n","type":"text/plain"},"key":"last_name","value":"Santos"},{"description":{"content":"[Obrigatório][String] Nome da empresa cadastrada
\n","type":"text/plain"},"key":"company_name","value":"Empresa XYZ"},{"description":{"content":"[Obrigatório][String] E-mail da empresa e do administrador da conta (O e-mail da empresa pode ser alterado depois, o do admin não, Limite de 255 carácteres)
\n","type":"text/plain"},"key":"email","value":"guilherme@teste.com.br"},{"description":{"content":"[Obrigatório][String] CNPJ da empresa devidamente formatado ou apenas números
\n","type":"text/plain"},"key":"cnpj","value":"11.000.333/0001-29"},{"description":{"content":"[Obrigatório][String] Endereço da empresa
\n","type":"text/plain"},"key":"address","value":"Rua dos anjos, 123, Centro, São Paulo"},{"description":{"content":"[Obrigatório][String] Telefone da empresa, somente números com DDD, caso seja um celular com WhatsApp, o mesmo será utilizado nas comunicações
\n","type":"text/plain"},"key":"phone","value":"96981448003"},{"description":{"content":"[Opcional][String] Senha de acesso do usuário administrador da empresa, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.
\n","type":"text/plain"},"key":"password","value":"123456"},{"description":{"content":"[Opcional][String] Status na plataforma, pode ser Active, Suspended ou Inactive
\n","type":"text/plain"},"key":"status","value":"Inactive"},{"description":{"content":"[Opcional][Int] Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text/plain"},"key":"recive_whatsapp","value":"0"},{"description":{"content":"[Opcional][Int] Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text/plain"},"key":"recive_email","value":"0"}],"variable":[]}},"response":[{"id":"b04479ea-717b-4805-bd65-b3ab10031896","name":"Create company - reseller","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"url":{"raw":"https://app.plugsign.com.br/api/companies?name=Guilherme&last_name=Santos&company_name=Empresa XYZ&email=guilherme@teste.com.br&cnpj=11.000.333/0001-29&address=Rua dos anjos, 123, Centro, São Paulo&phone=96981448003&password=123456","protocol":"https","host":["app","plugsign","com","br"],"path":["api","companies"],"query":[{"key":"name","value":"Guilherme","description":"[Obrigatório][String] Primeiro nome do administrador da empresa"},{"key":"last_name","value":"Santos","description":"[Obrigatório][String] Sobrenome do administrador da empresa"},{"key":"company_name","value":"Empresa XYZ","description":"[Obrigatório][String] Nome da empresa cadastrada"},{"key":"email","value":"guilherme@teste.com.br","description":"[Obrigatório][String] E-mail da empresa e do administrador da conta (O e-mail da empresa pode ser alterado depois, o do admin não)"},{"key":"cnpj","value":"11.000.333/0001-29","description":"[Obrigatório][String] CNPJ da empresa devidamente formatado ou apenas números"},{"key":"address","value":"Rua dos anjos, 123, Centro, São Paulo","description":"[Obrigatório][String] Endereço da empresa"},{"key":"phone","value":"96981448003","description":"[Obrigatório][String] Telefone da empresa, somente números com DDD, caso seja um celular com WhatsApp, o mesmo será utilizado nas comunicações"},{"key":"password","value":"123456","description":"[Opcional][String] Senha de acesso do usuário administrador da empresa, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:41 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Cliente cadastrado com sucesso!\",\n \"token_type\": \"Bearer\",\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLmNvbS5iclwvYXBpXC9jb21wYW5pZXMiLCJpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw\",\n \"company\": {\n \"id\": 148,\n \"name\": \"Empresa XYZ\",\n \"email\": \"guilherme@teste.com.br\",\n \"phone\": \"96981448003\",\n \"cnpj\": \"11.000.333/0001-29\",\n \"address\": \"Rua dos anjos, 123, Centro, São Paulo\",\n \"access\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLmNvbS5iclwvYXBpXC9jb21wYW5pZXMiLCJpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw\"\n }\n }\n}"}],"_postman_id":"e0117213-8cb4-4605-9b5f-0073d4a598e5"},{"name":"Update companie data","id":"de8b2339-1388-4321-956a-2cf54995882d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/companies/{{company_id}}?name=Guilherme&cnpj=11.000.333/0001-29&address=Rua dos anjos, 123, Centro, São Paulo&phone=96981448003&status=Active&recive_whatsapp=0&recive_email=0","description":"Com este endpoint você pode criar uma conta para uma empresa cliente e manipular a mesma com o seu respectivo token.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies","{{company_id}}"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Nome da empresa cadastrada
\n","type":"text/plain"},"key":"name","value":"Guilherme"},{"description":{"content":"[Obrigatório][String] CNPJ da empresa devidamente formatado ou apenas números
\n","type":"text/plain"},"key":"cnpj","value":"11.000.333/0001-29"},{"description":{"content":"[Obrigatório][String] Endereço da empresa
\n","type":"text/plain"},"key":"address","value":"Rua dos anjos, 123, Centro, São Paulo"},{"description":{"content":"[Obrigatório][String] Telefone da empresa, somente números com DDD, caso seja um celular com WhatsApp, o mesmo será utilizado nas comunicações
\n","type":"text/plain"},"key":"phone","value":"96981448003"},{"description":{"content":"[Obrigatório][String] Status da conta da empresa, podendo ser Active, Inactive ou Suspended
\n","type":"text/plain"},"key":"status","value":"Active"},{"description":{"content":"[Opcional][Int] Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text/plain"},"key":"recive_whatsapp","value":"0"},{"description":{"content":"[Opcional][Int] Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text/plain"},"key":"recive_email","value":"0"}],"variable":[]}},"response":[{"id":"66739607-c198-4654-b786-f64c667480e2","name":"Create company - reseller","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"url":{"raw":"https://app.plugsign.com.br/api/companies?name=Guilherme&last_name=Santos&company_name=Empresa XYZ&email=guilherme@teste.com.br&cnpj=11.000.333/0001-29&address=Rua dos anjos, 123, Centro, São Paulo&phone=96981448003&password=123456","protocol":"https","host":["app","plugsign","com","br"],"path":["api","companies"],"query":[{"key":"name","value":"Guilherme","description":"[Obrigatório][String] Primeiro nome do administrador da empresa"},{"key":"last_name","value":"Santos","description":"[Obrigatório][String] Sobrenome do administrador da empresa"},{"key":"company_name","value":"Empresa XYZ","description":"[Obrigatório][String] Nome da empresa cadastrada"},{"key":"email","value":"guilherme@teste.com.br","description":"[Obrigatório][String] E-mail da empresa e do administrador da conta (O e-mail da empresa pode ser alterado depois, o do admin não)"},{"key":"cnpj","value":"11.000.333/0001-29","description":"[Obrigatório][String] CNPJ da empresa devidamente formatado ou apenas números"},{"key":"address","value":"Rua dos anjos, 123, Centro, São Paulo","description":"[Obrigatório][String] Endereço da empresa"},{"key":"phone","value":"96981448003","description":"[Obrigatório][String] Telefone da empresa, somente números com DDD, caso seja um celular com WhatsApp, o mesmo será utilizado nas comunicações"},{"key":"password","value":"123456","description":"[Opcional][String] Senha de acesso do usuário administrador da empresa, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:41 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Cliente cadastrado com sucesso!\",\n \"token_type\": \"Bearer\",\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLmNvbS5iclwvYXBpXC9jb21wYW5pZXMiLCJpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw\",\n \"company\": {\n \"id\": 148,\n \"name\": \"Empresa XYZ\",\n \"email\": \"guilherme@teste.com.br\",\n \"phone\": \"96981448003\",\n \"cnpj\": \"11.000.333/0001-29\",\n \"address\": \"Rua dos anjos, 123, Centro, São Paulo\",\n \"access\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLmNvbS5iclwvYXBpXC9jb21wYW5pZXMiLCJpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw\"\n }\n }\n}"}],"_postman_id":"de8b2339-1388-4321-956a-2cf54995882d"},{"name":"Get companies","id":"0d879b21-bacc-4891-919a-728838f4df81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://app.plugsign.com.br/api/companies","description":"Através deste endpoint é possível recuperar os dados das subcontas que você criou, assim como seu token para acesso a conta novamente.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"d60e06d3-8a0f-447c-a920-146068bd8b54","name":"Get companies - reseller","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"https://app.plugsign.com.br/api/companies?name=Empresa XYZ","protocol":"https","host":["app","plugsign","com","br"],"path":["api","companies"],"query":[{"key":"name","value":"Empresa XYZ","description":"[Opcional][String] Nome da empresa cadastrada no sistema"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:52 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 148,\n \"name\": \"Empresa XYZ\",\n \"email\": \"guilherme@teste.com.br\",\n \"phone\": \"96981448003\",\n \"cnpj\": \"11.000.333/0001-29\",\n \"address\": \"Rua dos anjos, 123, Centro, São Paulo\",\n \"access\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLmNvbS5iclwvYXBpXC9jb21wYW5pZXMiLCJpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw\"\n }\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/companies?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/companies?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/companies?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/companies\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"0d879b21-bacc-4891-919a-728838f4df81"},{"name":"Get single companie data","id":"e3217134-25c0-4d78-81d0-11183fd0e634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"IMPORTANTE: Caso precise redefinir o token de uma conta, por vazamento ou qualquer problema, solicite diretamente ao suporte!
\n
Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://app.plugsign.com.br/api/companies/reseller/{id}","description":"Através deste endpoint é possível recuperar os dados das subcontas que você criou, assim como seu token para acesso a conta novamente.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies","reseller","{id}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"3bb50278-0017-4418-90fc-9d3b170250c5","name":"Get companies - reseller","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"https://app.plugsign.com.br/api/companies?name=Empresa XYZ","protocol":"https","host":["app","plugsign","com","br"],"path":["api","companies"],"query":[{"key":"name","value":"Empresa XYZ","description":"[Opcional][String] Nome da empresa cadastrada no sistema"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:53:52 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 148,\n \"name\": \"Empresa XYZ\",\n \"email\": \"guilherme@teste.com.br\",\n \"phone\": \"96981448003\",\n \"cnpj\": \"11.000.333/0001-29\",\n \"address\": \"Rua dos anjos, 123, Centro, São Paulo\",\n \"access\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLmNvbS5iclwvYXBpXC9jb21wYW5pZXMiLCJpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw\"\n }\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/companies?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/companies?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/companies?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/companies\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"e3217134-25c0-4d78-81d0-11183fd0e634"},{"name":"Update company SMTP","id":"0931ea7b-8bdc-4ed4-bad8-377e4693d8e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/companies/conf/email?mail_host=mail.assinadoc.com&mail_from=contato@plugsign.com.br&mail_username=contato@plugsign.com.br&mail_password=123123&mail_encryption=tsl&mail_port=645","description":"IMPORTANTE: Caso precise redefinir o token de uma conta, por vazamento ou qualquer problema, solicite diretamente ao suporte!
\n
Com este endpoint você pode atualizar os dados de e-mail personalizados de uma conta.
\nApós o envio, as configurações são aplicadas e todos os e-mails enviados para documentos relacionados a empresa utilizam as credenciais.
\n\n\nVerifique se os dados estão corretos e teste assim que realizar as configurações, pois caso seu provedor não permita envios por SMTP ou alguma configurações esteja errada, os envios de solicitações podem ser interrompidos!
\n
Atenção! Utilizar credenciais personalizadas pode fazer com que os registros de mensagens enviadas não funcione corretamente, para configurar o retorno dos dados entre em contato com o suporte!
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies","conf","email"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório] Host do seu provedor de e-mails
\n","type":"text/plain"},"key":"mail_host","value":"mail.assinadoc.com"},{"description":{"content":"[Obrigatório] Qual endereço de e-mail está enviando a mensagem
\n","type":"text/plain"},"key":"mail_from","value":"contato@plugsign.com.br"},{"description":{"content":"[Obrigatório] Usuário de e-mail para autenticação (Na maioria dos casos é o mesmo do mail_from)
\n","type":"text/plain"},"key":"mail_username","value":"contato@plugsign.com.br"},{"description":{"content":"[Obrigatório] Senha do e-mail
\n","type":"text/plain"},"key":"mail_password","value":"123123"},{"description":{"content":"[Obrigatório] Tipo de autenticação, aceito apenas tsl ou ssl
\n","type":"text/plain"},"key":"mail_encryption","value":"tsl"},{"description":{"content":"[Obrigatório] Porta de saída do provedor, somente números
\n","type":"text/plain"},"key":"mail_port","value":"645"}],"variable":[]}},"response":[{"id":"06335529-cf14-4d13-92ca-ba991b39a205","name":"Update email data","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/companies/conf/email?mail_host=mail.assinadoc.com&mail_from=contato@plugsign.com.br&mail_username=contato@plugsign.com.br&mail_password=123123&mail_encryption=tsl&mail_port=645","protocol":"https","host":["app","plugsign","com","br"],"path":["api","companies","conf","email"],"query":[{"key":"mail_host","value":"mail.assinadoc.com","description":"[Obrigatório] Host do seu provedor de e-mails"},{"key":"mail_from","value":"contato@plugsign.com.br","description":"[Obrigatório] Qual endereço de e-mail está enviando a mensagem"},{"key":"mail_username","value":"contato@plugsign.com.br","description":"[Obrigatório] Usuário de e-mail para autenticação (Na maioria dos casos é o mesmo do mail_from)"},{"key":"mail_password","value":"123123","description":"[Obrigatório] Senha do e-mail"},{"key":"mail_encryption","value":"tsl","description":"[Obrigatório] Tipo de autenticação, aceito apenas tsl ou ssl"},{"key":"mail_port","value":"645","description":"[Obrigatório] Porta de saída do provedor, somente números"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 13:49:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=k6kf6x6iSTKdwgsHKnlDEbnmycLiGx0Et2hScdfTNx65AYB%2Fn204LoWbMBZ70C2KY%2BmV6sguEWOeND6u7NEzbdS%2FBQwEhtR5%2BfCDYcYOyeJgpLLhdHdhkcjlAj2evPZSffjS3h46\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0f0656e86fa5a1-GRU"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Configurações de e-mail salva com sucesso!\"\n}"}],"_postman_id":"0931ea7b-8bdc-4ed4-bad8-377e4693d8e9"},{"name":"Set company limits","id":"65ffaccc-01be-4c3a-9ab7-ec06f4b1e0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limits\": [\n {\n \"type\": \"disk\",\n \"limit\": 1024\n },\n {\n \"type\": \"users\",\n \"limit\": 10\n },\n {\n \"type\": \"files\",\n \"limit\": 200\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/companies/733/limits","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies","733","limits"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"940485a5-476f-4552-8c2c-5533dd0c3e5a","name":"Update company limits","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer zcJLSJC2qqPc3CNeOFgcB6stYFYFR4iaGPtQe5v4vZ0vMg1nD6FrwVY8Jde52oK8ISRXA4cZ4Ixfrk9nbj0Y7vzVI1u5NCCurtxwiWpm3y55jt9NrVX1lGs9CPQDWLu84uH3eBDIpb5SXRkyBz5Airq1auIznqqc9jbgx8NYrLMVtUDeLfmjCh5LPcRnjac1Mxg6dVmWygxMEjkcci8LNm94dSj7URbA7IcmaoIBymCRSxhmHqFYaBOhBWMJMv5YHkHyLxC0QEzD8m7fKHuZejvvAUuhcfxrKYfTTbwY92tg9m3Xky1GJ2dR0tdLbzvgpo3x3NRJahFEbCRkg","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"body":{"mode":"raw","raw":"{\"limits\": [\n {\n \"type\": \"disk\",\n \"limit\": 1024\n },\n {\n \"type\": \"users\",\n \"limit\": 10\n },\n {\n \"type\": \"files\",\n \"limit\": 200\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/companies/733/limits"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Feb 2024 14:23:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"40"},{"key":"X-RateLimit-Remaining","value":"37"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=CDo6YuHEmPAU5wdHZw7TTaQFagv4fq0LjFGSm3MQW4L0LNsmDoyW4fkSNIlV34Cz57fqWABn7bitroUaqYQM%2BqtXNl5jIOT9esaKkFNhfVUKBBAoh37KdYw7yx0RIaJBaJgkYN5D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"84eada9c0cfc77f6-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Limite criado com sucesso!\"\n}"}],"_postman_id":"65ffaccc-01be-4c3a-9ab7-ec06f4b1e0ec"},{"name":"Companies custom limit","id":"471cb764-45ac-4a76-aba5-f2c4fd6b64ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso (Do revendedor)
\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limits\": [\n {\n \"type\": \"disk\",\n \"limit\": 1024\n },\n {\n \"type\": \"users\",\n \"limit\": 10\n },\n {\n \"type\": \"files\",\n \"limit\": 300\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/companies/{{company_id}}/limits","description":"É possível definir limites personalizados por empresas, para contas de colaboradores, usdo de disco (Em MB) e arquivos.
\nPara isto passe um json com o objeto limits, e nele um array com até 3 elementos representando os itens files, users e disk.
\nCada um recebe um número inteiro, não é necessário informar os 3.
\nAo passar limites para uma conta que já possuí, eles são atualziados para os novos enviados.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","companies","{{company_id}}","limits"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"d40848cd-5f95-421a-8554-92fdc4124c65","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso (Do revendedor)","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limits\": [\n {\n \"type\": \"disk\",\n \"limit\": 1024\n },\n {\n \"type\": \"users\",\n \"limit\": 10\n },\n {\n \"type\": \"files\",\n \"limit\": 300\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://app.plugsign.com.br/api/companies/734/limits","protocol":"https","host":["app","plugsign","com","br"],"path":["api","companies","734","limits"],"query":[{"key":"limits[disk]","value":"123","disabled":true},{"key":"limits[users]","value":"321","disabled":true},{"key":"limits[files]","value":"456","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 18:25:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=x8opk2lNa8zH5HOpa6NGsnt9bgCgmF4UWqoKf7pVdU295zkF01HtIlwgn7YZuDaHSz1rdN4Csx5YUpesUTrOpgd0gGjyuzUirNd%2BjzsjRRUMDi842ZKeFzukoz3qscav00tPX%2FSj\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"866744b50d171186-GIG"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Limite criado com sucesso!\"\n}"}],"_postman_id":"471cb764-45ac-4a76-aba5-f2c4fd6b64ec"}],"id":"3ee61d0b-d77e-4c13-807e-60066270c257","description":"As empresas permitem que você crie subcontas para empresas clientes operarem o sistema pelo Front End e para que você integre seu sistema pela conta do seu cliente.
\nAo criar uma empresa, você gera um usuário administrador para seu cliente, que pode ou não ser avisado por e-mail sobre tal, assim como gera um token para poder manipular a sua conta via API.
\nÉ importante resaltar que no PlugSign possuímos alguns níveis de usuários, sendo eles os seguintes:
\n\n\nAs sub contas de empresas criadas por um revendedor herdam a sua marca, portanto se a Software House XYZ criar a conta para a Clínica médica ABC, a clínica vai utilizar o PlugSign com a marca da Software House.
\n
Confira abaixo uma representação gráfica da estrutura de contas e um vídeo falando mais sobre a hierarquia das mesmas:
\nConfira neste vídeo como as contas funcionam: https://youtu.be/0itUbITqBKU
\n","_postman_id":"3ee61d0b-d77e-4c13-807e-60066270c257","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Customers","item":[{"name":"Add new customer","id":"918a7ec1-52f7-46e9-b3de-cbc968127aec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Joaquim","description":"[Obrigatório][String] Primeiro nome do cliente adicionado.
\n","type":"text"},{"key":"last_name","value":"Silva","description":"[Obrigatório][String] Sobrenome do cliente adicionado.
\n","type":"text"},{"key":"email","value":"joaquim@teste.com.br","description":"[Obrigatório][String] E-mail do seu cliente (Ele vai receber a senha de acesso neste e-mail).
\n","type":"text"},{"key":"phone","value":"11988554411","description":"[Obrigatório][Int] Número de celular com DDD, somente números.
\n","type":"text"},{"key":"address","value":"Rua Nove de Julho, 1234, Centro, São Paulo","description":"[Obrigatório][String] Endereço do seu cliente.
\n","type":"text"},{"key":"password","value":"123456","description":"[Opcional][String] Senha do seu cliente para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.
\n","type":"text"},{"key":"cert_file","description":"[Opcional] Arquivo do certificado digital PFX.
\n","type":"file","value":null},{"key":"cert_password","value":"123456","description":"[Opcional] Senha do certificado para validação, caso passe o certificado a senha é obrigatória.
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/customers","description":"Com a criação de clientes é possível disponibilizar contas no ambiente visual para que os clientes da empresa assinem documentos logados e tenham acesso rápido aos seus documentos.
\nAs contas para clientes são do modo \"Read only\", portanto não podem visualizar informações, criar pastas, enviar documentos nem fazer nenhuma ação no sistema além de assinar documentos para os quais recebeu uma solicitação de assinatura.
\nAs principais vantagens para se criar uma conta de cliente são:
\n\n\nAtenção! A criação de conta NÃO É OBRIGATÓRIA para assinar documentos, é possível solicitar assinaturas apenas pelo e-mail, a conta é um recurso que busca facilitar o dia a dia de clientes que assinam muitos documentos, portanto não é algo mandatório.
\n
Os clientes ou \"Customers\" são os clientes da empresa que envia os documentos, para criar subcontas empresariais em implantações para terceiros verifique os endpoints \"Companies\"
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","customers"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"cbdb048e-078e-4a90-ba6a-7f00c54c0f07","name":"Add new customer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/customers?name=Joaquim&last_name=Silva&email=joaquim@teste.com.br&phone=11988554411&address=Rua Nove de Julho, 1234, Centro, São Paulo&password=123456","protocol":"https","host":["app","plugsign","com","br"],"path":["api","customers"],"query":[{"key":"name","value":"Joaquim","description":"[Obrigatório][String] Primeiro nome do cliente adicionado"},{"key":"last_name","value":"Silva","description":"[Obrigatório][String] Sobrenome do cliente adicionado"},{"key":"email","value":"joaquim@teste.com.br","description":"[Obrigatório][String] E-mail do seu cliente (Ele vai receber a senha de acesso neste e-mail)"},{"key":"phone","value":"11988554411","description":"[Obrigatório][Int] Número de celular com DDD, somente números.\n"},{"key":"address","value":"Rua Nove de Julho, 1234, Centro, São Paulo","description":"[Obrigatório][String] Endereço do seu cliente"},{"key":"password","value":"123456","description":"[Opcional][String] Senha do seu cliente para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:54:13 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 289,\n \"name\": \"Joaquim\",\n \"last_name\": \"Silva\",\n \"phone\": \"11988554411\",\n \"address\": \"Rua Nove de Julho, 1234, Centro, São Paulo\",\n \"email\": \"joaquim@teste.com.br\"\n },\n \"message\": \"Cliente cadastrado com sucesso!\"\n}"}],"_postman_id":"918a7ec1-52f7-46e9-b3de-cbc968127aec"},{"name":"Update customer","id":"cb395bad-16a8-4f06-8383-fead83aa81e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Joaquim","description":"[Obrigatório][String] Primeiro nome do cliente adicionado na plataforma
\n","type":"text"},{"key":"last_name","value":"Silveira","description":"[Obrigatório][String] Sobrenome do cliente adicionado na plataforma
\n","type":"text"},{"key":"phone","value":"11988889999","description":"[Obrigatório][Int] Número de telefone com o 9 do cliente, caso seja um WhatsApp, o mesmo será utilizado para envio de alertas e notificações, incluindo quando uma assinatura for solicitada ao mesmo
\n","type":"text"},{"key":"address","value":"Rua Nove de Julho, 123, São Paulo","description":"[Obrigatório][String] Endereço do seu cliente adicionado na plataforma
\n","type":"text"},{"key":"cert_file","description":"[Opcional] Arquivo do certificado digital PFX.
\n","type":"file","value":null},{"key":"cert_password","value":"123456","description":"[Opcional] Senha do certificado para validação, caso passe o certificado a senha é obrigatória.
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/customers/joaquim@teste.com.br","description":"Este endpoint permite que você edite as informações de um cliente de forma rápida.
\nO endereço de e-mail do seu cliente não pode ser editado, pois é uma chave primária essencial para o PlugSign.
\nPortanto caso precise editar o endereço de e-mail sugerimos que apague a conta do cliente e crie uma nova conta, tendo em vista que com o endereço errado, o cliente não receberá a senha de acesso.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","customers","joaquim@teste.com.br"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb395bad-16a8-4f06-8383-fead83aa81e0"},{"name":"Get customers","id":"19126273-ed9a-4e8d-ae0f-1f6022606e62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/customers?id=123&name=João&last_name=Silva&email=joaquim@teste.com.br&phone=11988334466&address=Rua Nove de Julho, 123, São Paulo","description":"Este endpoint lista todas as contas dos clientes da empresa atual, fornecendo rápido acesso as suas informações e dados.
\n[Opcional][Int] ID do seu cliente adicionado na plataforma
\n","type":"text/plain"},"key":"id","value":"123"},{"description":{"content":"[Opcional][String] Primeiro nome do cliente adicionado na plataforma
\n","type":"text/plain"},"key":"name","value":"João"},{"description":{"content":"[Opcional][String] Sobrenome do cliente adicionado na plataforma
\n","type":"text/plain"},"key":"last_name","value":"Silva"},{"description":{"content":"[Opcional][String] Endereço de e-mail do cliente adicionado na plataforma
\n","type":"text/plain"},"key":"email","value":"joaquim@teste.com.br"},{"description":{"content":"[Opcional][Int] Número de telefone com o 9 do cliente, caso seja um WhatsApp, o mesmo será utilizado para envio de alertas e notificações, incluindo quando uma assinatura for solicitada ao mesmo
\n","type":"text/plain"},"key":"phone","value":"11988334466"},{"description":{"content":"[Opcional][String] Endereço do seu cliente adicionado na plataforma
\n","type":"text/plain"},"key":"address","value":"Rua Nove de Julho, 123, São Paulo"}],"variable":[]}},"response":[{"id":"8a0a58e0-40e5-427a-8cc8-e91b8a078225","name":"Get customers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/customers?email=joaquim@teste.com.br","protocol":"https","host":["app","plugsign","com","br"],"path":["api","customers"],"query":[{"key":"id","value":"123","description":"[Opcional][Int] ID do seu cliente adicionado na plataforma","disabled":true},{"key":"name","value":"João","description":"[Opcional][String] Primeiro nome do cliente adicionado na plataforma","disabled":true},{"key":"last_name","value":"Silva","description":"[Opcional][String] Sobrenome do cliente adicionado na plataforma","disabled":true},{"key":"email","value":"joaquim@teste.com.br","description":"[Opcional][String] Endereço de e-mail do cliente adicionado na plataforma"},{"key":"phone","value":"11988334466","description":"[Opcional][Int] Número de telefone com o 9 do cliente, caso seja um WhatsApp, o mesmo será utilizado para envio de alertas e notificações, incluindo quando uma assinatura for solicitada ao mesmo","disabled":true},{"key":"address","value":"Rua Nove de Julho, 123, São Paulo","description":"[Opcional][String] Endereço do seu cliente adicionado na plataforma","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:57:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"53"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 290,\n \"name\": \"Joaquim\",\n \"last_name\": \"Silva\",\n \"phone\": \"11988554411\",\n \"address\": \"Rua Nove de Julho, 1234, Centro, São Paulo\",\n \"email\": \"joaquim@teste.com.br\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/customers?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/customers?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/customers?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/customers\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"19126273-ed9a-4e8d-ae0f-1f6022606e62"},{"name":"Get single customer user","id":"0396e6ff-26e6-4048-8fd3-5c1589bff567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.plugsign.com.br/api/customers/{id}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","customers","{id}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"0396e6ff-26e6-4048-8fd3-5c1589bff567"},{"name":"Delete customer","id":"c79c5a52-0190-427a-98e1-de196961fe02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/customers?email=joaquim@teste.com.br","description":"Este endpoint permite que você apague a conta de um cliente.
\nComo os clientes não podem criar pastas e/ou documentos, apagar a conta do mesmo não terá nenhum impacto nos demais dados.
\nAs assinaturas do mesmo vão permanecer no sistema, assim como os documentos que o mesmo assinou.
\nAs únicas mudanças visuais que vão ocorrer são:
\n[Obrigatório][String] E-mail do seu cliente para apagar a conta, como o mesmo não pode criar novos arquivos, não haverá alteração nos documentos existentes
\n","type":"text/plain"},"key":"email","value":"joaquim@teste.com.br"}],"variable":[]}},"response":[{"id":"92f09540-45f2-4fd1-823b-035d0bf4b381","name":"Delete customer","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/customers?email=joaquim@teste.com.br","protocol":"https","host":["app","plugsign","com","br"],"path":["api","customers"],"query":[{"key":"email","value":"joaquim@teste.com.br","description":"[Obrigatório][String] E-mail do seu cliente para apagar a conta, como o mesmo não pode criar novos arquivos, não haverá alteração nos documentos existentes"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:56:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Cliente deletado com sucesso!\"\n}"}],"_postman_id":"c79c5a52-0190-427a-98e1-de196961fe02"}],"id":"36e9c1f1-aa5e-488e-af77-a095592c5fa1","description":"Com os endpoints de Customers é possível disponibilizar contas no ambiente visual para que os clientes da empresa assinem documentos logados e tenham acesso rápido aos seus documentos.
\nOs clientes ou \"Customers\" são os clientes da empresa que envia os documentos, para criar subcontas empresariais em implantações para terceiros verifique os endpoints \"Companies\"
\nCaso crie uma conta para um cliente, o mesmo irá receber por e-mail uma senha temporária para acessar o sistema PlugSign, com ela o mesmo poderá:
\nPorém fique atento(a), a conta de clientes possuí limitações, com ela seu cliente NÃO PODERÁ:
\nSeu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"João","description":"[Obrigatório][String] Primeiro nome do colaborador para cadastro no sistema
\n","type":"text"},{"key":"last_name","value":"Silveira","description":"[Obrigatório][String] Sobrenome do colaborador para cadastro no sistema
\n","type":"text"},{"key":"phone","value":"11977885544","description":"[Obrigatório][Int] Telefone celular do colaborador com DDD e 9, será utilizado para notificações da conta caso ativadas
\n","type":"text"},{"key":"email","value":"joao@teste.com","description":"[Obrigatório][String] E-mail do colaborador, o(a) mesmo(a) receberá um e-mail com a senha temporária no ato da criação da conta
\n","type":"text"},{"key":"password","value":"1234","description":"[Opcional][String] Senha do seu colaborador para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.
\n","type":"text"},{"key":"permissions[0]","value":"upload","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para fazer upload de novos documentos e criar pastas na plataforma
\n","type":"text"},{"key":"permissions[1]","value":"edit","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para editar e assinar documentos, mesmo sem receber uma solicitação (Caso não tenha esta permissão, ainda poderá assinar documentos por meio de solicitações diretas)
\n","type":"text"},{"key":"permissions[2]","value":"delete","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para apagar documentos e/ou pastas na plataforma.
\n","type":"text"},{"key":"permissions[3]","value":"send_request","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para enviar documentos para outras pessoas assinarem e/ou preencherem informações.
\n","type":"text"},{"key":"permissions[4]","value":"protect","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para ativar proteção de documentos e/ou pastas, definir senha em pastas e utilizar todos os recursos de segurança de documentos.
\n","type":"text"},{"key":"cert_file","description":"[Opcional] Arquivo do certificado digital PFX
\n","type":"file","value":null},{"key":"cert_password","value":"123456","description":"[Opcional] Senha do certificado para validação, caso passe o certificado a senha é obrigatória
\n","type":"text"},{"key":"recive_whatsapp","value":"1","description":"[Opcional][Int] Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text"},{"key":"recive_email","value":"1","description":"[Opcional][Int] Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/teams","description":"Com este enpoint você pode criar contas de colaboradores, para que os mesmos possuam cesso ao sistema via fron-end e possam utilizar a plataforma, assim como visualizar os dados submetidos via API.
\nCaso não queira fornecer acessos aos colaboradores, é possível manipular o sistema sem tais contas, executando todas as ações como administrador do sistema.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","teams"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"db46ac69-0511-412e-9458-25ebda106755","name":"Create new team user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/teams?name=João&last_name=Silveira&phone=11977885544&email=joao@teste.com&password=123456&permissions[0]=upload&permissions[1]=edit&permissions[2]=delete&permissions[3]=send_request&permissions[4]=protect","protocol":"https","host":["app","plugsign","com","br"],"path":["api","teams"],"query":[{"key":"name","value":"João","description":"[Obrigatório][String] Primeiro nome do colaborador para cadastro no sistema"},{"key":"last_name","value":"Silveira","description":"[Obrigatório][String] Sobrenome do colaborador para cadastro no sistema"},{"key":"phone","value":"11977885544","description":"[Obrigatório][Int] Telefone celular do colaborador com DDD e 9, será utilizado para notificações da conta caso ativadas "},{"key":"email","value":"joao@teste.com","description":"[Obrigatório][String] E-mail do colaborador, o(a) mesmo(a) receberá um e-mail com a senha temporária no ato da criação da conta"},{"key":"password","value":"123456","description":"[Opcional][String] Senha do seu colaborador para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo."},{"key":"permissions[0]","value":"upload","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para fazer upload de novos documentos e criar pastas na plataforma"},{"key":"permissions[1]","value":"edit","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para editar e assinar documentos, mesmo sem receber uma solicitação (Caso não tenha esta permissão, ainda poderá assinar documentos por meio de solicitações diretas)"},{"key":"permissions[2]","value":"delete","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para apagar documentos e/ou pastas na plataforma"},{"key":"permissions[3]","value":"send_request","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para enviar documentos para outras pessoas assinarem e/ou preencherem informações"},{"key":"permissions[4]","value":"protect","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para ativar proteção de documentos e/ou pastas, definir senha em pastas e utilizar todos os recursos de segurança de documentos"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:58:23 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 291,\n \"name\": \"João\",\n \"last_name\": \"Silveira\",\n \"email\": \"joao@teste.com\",\n \"permissions\": [\n \"upload\",\n \"edit\",\n \"delete\",\n \"send_request\",\n \"protect\"\n ]\n },\n \"message\": \"Tudo pronto! Conta criada com sucesso! O colaborador vai receber um e-mail para criar sua senha.\"\n}"}],"_postman_id":"1bf444cc-14d9-40f5-a66f-9373d7548fa0"},{"name":"Update team user","id":"e92a1d62-3a08-4a75-b2d3-67e6ab5801c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Atenção! Ao criar uma conta de colabroador, é possível avisa-lo ou não da mesma, caso você informe o parâmetro password, ele não será avisado da criação da conta nem vai receber alertas do sistema (Para uso WhiteLabel), caso NÃO passe uma senha, o sistema vai gerar uma automaticamente e enviar para o seu e-mail, portanto o mesmo vai ter conhecimento da conta e terá uma forma de acessar a plataforma.
\n
Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT
\n"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"João","description":"[Obrigatório][String] Primeiro nome do colaborador para cadastro no sistema
\n","type":"text"},{"key":"last_name","value":"Silveira","description":"[Obrigatório][String] Sobrenome do colaborador para cadastro no sistema
\n","type":"text"},{"key":"phone","value":"11977885544","description":"[Obrigatório][Int] Telefone celular do colaborador com DDD e 9, será utilizado para notificações da conta caso ativadas
\n","type":"text"},{"key":"email","value":"joao@teste.com","description":"[Obrigatório][String] E-mail do colaborador, o(a) mesmo(a) receberá um e-mail com a senha temporária no ato da criação da conta
\n","type":"text"},{"key":"password","value":"1234","description":"[Opcional][String] Senha do seu colaborador para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.
\n","type":"text"},{"key":"permissions[0]","value":"upload","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para fazer upload de novos documentos e criar pastas na plataforma.
\n","type":"text"},{"key":"permissions[1]","value":"edit","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para editar e assinar documentos, mesmo sem receber uma solicitação (Caso não tenha esta permissão, ainda poderá assinar documentos por meio de solicitações diretas).
\n","type":"text"},{"key":"permissions[2]","value":"delete","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para apagar documentos e/ou pastas na plataforma.
\n","type":"text"},{"key":"permissions[3]","value":"send_request","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para enviar documentos para outras pessoas assinarem e/ou preencherem informações.
\n","type":"text"},{"key":"permissions[4]","value":"protect","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para ativar proteção de documentos e/ou pastas, definir senha em pastas e utilizar todos os recursos de segurança de documentos.
\n","type":"text"},{"key":"cert_file","description":"[Opcional] Arquivo do certificado digital PFX
\n","type":"file","value":null},{"key":"cert_password","value":"1234","description":"[Opcional] Senha do certificado para validação, caso passe o certificado a senha é obrigatória
\n","type":"text"},{"key":"recive_whatsapp","value":"1","description":"[Opcional][Int] Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text"},{"key":"recive_email","value":"1","description":"[Opcional][Int] Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.
\n","type":"text"}]},"url":"https://app.plugsign.com.br/api/teams/joao@teste.com","description":"Através deste endpoint é possível atualizar dados dos colaboradores ou permissões de acesso a plataforma.
\nNote que o e-mail não é passível de atualização, uma vez que é um identificador único, portanto caso seja necessário alterar o mesmo, recomendamos a exclusão da conta e criação de uma nova.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","teams","joao@teste.com"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"2b829a65-394c-427e-8e8e-be8c8d7004ff","name":"Update team user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","type":"text","description":"Necessário deixar explicito o retorno em POST e PUT"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.plugsign.com.br/api/teams/joao@teste.com?name=João&last_name=Rodrigues&phone=11977885533&permissions[0]=upload&permissions[1]=edit&permissions[2]=delete","protocol":"https","host":["app","plugsign","com","br"],"path":["api","teams","joao@teste.com"],"query":[{"key":"name","value":"João","description":"[Obrigatório][String] Primeiro nome do colaborador para cadastro no sistema"},{"key":"last_name","value":"Rodrigues","description":"[Obrigatório][String] Sobrenome do colaborador para cadastro no sistema"},{"key":"phone","value":"11977885533","description":"[Obrigatório][Int] Telefone celular do colaborador com DDD e 9, será utilizado para notificações da conta caso ativadas "},{"key":"permissions[0]","value":"upload","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para fazer upload de novos documentos e criar pastas na plataforma"},{"key":"permissions[1]","value":"edit","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para editar e assinar documentos, mesmo sem receber uma solicitação (Caso não tenha esta permissão, ainda poderá assinar documentos por meio de solicitações diretas)"},{"key":"permissions[2]","value":"delete","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para apagar documentos e/ou pastas na plataforma"},{"key":"permissions[3]","value":"send_request","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para enviar documentos para outras pessoas assinarem e/ou preencherem informações","disabled":true},{"key":"permissions[4]","value":"protect","description":"[Obrigatório mesmo que um array vazio][Array de strings] Permissão para ativar proteção de documentos e/ou pastas, definir senha em pastas e utilizar todos os recursos de segurança de documentos","disabled":true},{"key":"cert_file","value":null,"description":"[Opcional] Arquivo do certificado digital PFX","type":"text","disabled":true},{"key":"cert_password","value":"123","description":"[Opcional] Senha do certificado para validação, caso passe o certificado a senha é obrigatória","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:59:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Colaboarador alterado com sucesso!\"\n}"}],"_postman_id":"e92a1d62-3a08-4a75-b2d3-67e6ab5801c6"},{"name":"Get team","id":"7d9aeb56-9b74-4c45-930c-7448f795ef31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"(Caso não seja possível, solicite a alteração diretamente ao suporte)
\n
Seu token de acesso para a conta desejada
\n"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/teams?id=123&name=João&last_name=Silva&email=joao@teste.com&role=admin","description":"Através deste enfdpoint você pode recuperar todas as contas de colaboradores ou filtrar para buscar uma conta específica.
\nAtravés deste endpoint é possível obter o ID do colaborador, que pode ser utilizado no envio de solicitações de assinatura para conectar um colaborador a uma solicitação.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","teams"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Opcional][Int] ID único do seu colaborador que foi cadastrado no sistema
\n","type":"text/plain"},"key":"id","value":"123"},{"description":{"content":"[Opcional][String] Primeiro nome do seu colaborador cadastrado no sistema
\n","type":"text/plain"},"key":"name","value":"João"},{"description":{"content":"[Opcional][String] Sobrenome do seu colaborador cadastrado no sistema
\n","type":"text/plain"},"key":"last_name","value":"Silva"},{"description":{"content":"[Opcional][String] O endereço de e-mail do seu colaborador cadastrado no sistema
\n","type":"text/plain"},"key":"email","value":"joao@teste.com"},{"description":{"content":"[Opcional]{String] A posição do usuário, podendo ser admin (Administrador) ou staff (Parte do time da empresa)
\n","type":"text/plain"},"key":"role","value":"admin"}],"variable":[]}},"response":[{"id":"7f79789d-2f38-4da5-b4ea-74b4ecc61b8a","name":"Get team","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso para a conta desejada"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT","type":"text"}],"url":{"raw":"https://app.plugsign.com.br/api/teams?email=joao@teste.com","protocol":"https","host":["app","plugsign","com","br"],"path":["api","teams"],"query":[{"key":"id","value":"123","description":"[Opcional][Int] ID único do seu colaborador que foi cadastrado no sistema","disabled":true},{"key":"name","value":"João","description":"[Opcional][String] Primeiro nome do seu colaborador cadastrado no sistema","disabled":true},{"key":"last_name","value":"Silva","description":"[Opcional][String] Sobrenome do seu colaborador cadastrado no sistema","disabled":true},{"key":"email","value":"joao@teste.com","description":"[Opcional][String] O endereço de e-mail do seu colaborador cadastrado no sistema"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Aug 2022 13:58:50 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"55"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 291,\n \"name\": \"João\",\n \"last_name\": \"Silveira\",\n \"email\": \"joao@teste.com\",\n \"permissions\": [\n \"upload\",\n \"edit\",\n \"delete\",\n \"send_request\",\n \"protect\"\n ],\n \"recive_email\": 1,\n \"recive_whatsapp\": 0,\n \"role\": \"admin\",\n \"status\": \"Active\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.plugsign.com.br/api/teams?page=1\",\n \"last\": \"https://app.plugsign.com.br/api/teams?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://app.plugsign.com.br/api/teams?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://app.plugsign.com.br/api/teams\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"7d9aeb56-9b74-4c45-930c-7448f795ef31"},{"name":"Get single team member","id":"8343e3eb-f90a-4985-b7aa-01ef9c81f447","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/teams/{id}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","teams","{id}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"8343e3eb-f90a-4985-b7aa-01ef9c81f447"},{"name":"Delete team user","id":"4244e4a8-093f-41c8-8ede-6b10ae65d04b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso para a conta desejada
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Necessário deixar explicito o retorno em POST e PUT
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/teams?email=joao@teste.com","description":"Com este enpoint é possível apagar contas de colaboradores, note que este processo é IRREVERSÍVEL, sendo possível apenas criar novamente a conta, porém a nova conta não vai estar conectada aos dados que a antiga estava.
\nQuando uma conta é criada, algumas dependências são ajustadas, sendo elas:
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","teams"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"Lembrando que, caso queira apenas desativar uma conta de um colaborador, entre em contato com o suporte.
\n
[Obrigatório][String] E-mail do usuário do time para ser deletado, uma vez deletada a conta, os seus documentos e dados são transferidos ao administrador
\n","type":"text/plain"},"key":"email","value":"joao@teste.com"}],"variable":[]}},"response":[],"_postman_id":"4244e4a8-093f-41c8-8ede-6b10ae65d04b"}],"id":"3f09a0c2-fb85-4a9b-9e11-dd0068d91f83","description":"A criação de contas de colaboradores permite que você forneça um acesso para colaboradores da empresa utilizarem a plataforma pelo front-end.
\nAlém de fornecer o acesso ao colaborador, com uma conta criada é possível informar ao PlugSign que uma solicitação de assinatura foi feita a partir de um determinado colaborador, assim todos os alertas e notificações vão ser enviados para ele.
\nPor exemplo, você tem um sistema no qual vendedores geram e enviam orçamentos, é possível via API cadastrar cada vendedor, e quando um vendedor específico estiver operando seu software, voc6e poderá conectar os seus envios de orçamento a sua conta, assim ele vai receber alertas quando seus orçamentos forem abertos, assinados e etc.
\n","_postman_id":"3f09a0c2-fb85-4a9b-9e11-dd0068d91f83","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Departments","item":[{"name":"Get all departments","id":"4943c329-d1bd-4cb9-be0e-6937ce05f6ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Token de acesso do usuário.
\n","type":"text"},{"key":"Accept","value":"application/json","description":"Formato de dados aceito
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/departments","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","departments"],"host":["app","plugsign","com","br"],"query":[{"disabled":true,"description":{"content":"[Opcional] Nome do departamento buscado
\n","type":"text/plain"},"key":"name","value":"Comercial"},{"disabled":true,"description":{"content":"[Opcional] E-mail do departamento buscado
\n","type":"text/plain"},"key":"email","value":"comercial@teste.com.br"}],"variable":[]}},"response":[],"_postman_id":"4943c329-d1bd-4cb9-be0e-6937ce05f6ec"},{"name":"Get single department data","id":"507ce19c-4f85-4dc9-9664-bbc6d9ec9ae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.plugsign.com.br/api/departments/{id}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","departments","{id}"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"507ce19c-4f85-4dc9-9664-bbc6d9ec9ae1"},{"name":"Get all users from department","id":"cca01ce1-44d0-4587-974e-7605f82e55b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.plugsign.com.br/api/departments/{id}/users","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","departments","{id}","users"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"cca01ce1-44d0-4587-974e-7605f82e55b0"},{"name":"Createn a department","id":"75f37bfe-cef8-4d5e-84c2-1fe5c6190105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.plugsign.com.br/api/departments/?name=Comercial&email=comercial@teste.com.br","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","departments",""],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório] Nome do departamento
\n","type":"text/plain"},"key":"name","value":"Comercial"},{"description":{"content":"[Obrigatório] E-mail do departamento
\n","type":"text/plain"},"key":"email","value":"comercial@teste.com.br"}],"variable":[]}},"response":[],"_postman_id":"75f37bfe-cef8-4d5e-84c2-1fe5c6190105"},{"name":"Insert user on a department","id":"fcec6e0c-a1c4-41fd-aeff-f3e299cebe6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.plugsign.com.br/api/departments/?id=123&users[0]=4321&users[1]=4567&users[2]=4323","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","departments",""],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório] ID do departamento no qual vamos inserir os usuários
\n","type":"text/plain"},"key":"id","value":"123"},{"description":{"content":"[Obrigatório] Array com os ID`s dos usuários que vão ser incluídos no departamento
\n","type":"text/plain"},"key":"users[0]","value":"4321"},{"description":{"content":"[Obrigatório] Array com os ID`s dos usuários que vão ser incluídos no departamento
\n","type":"text/plain"},"key":"users[1]","value":"4567"},{"description":{"content":"[Obrigatório] Array com os ID`s dos usuários que vão ser incluídos no departamento
\n","type":"text/plain"},"key":"users[2]","value":"4323"}],"variable":[]}},"response":[],"_postman_id":"fcec6e0c-a1c4-41fd-aeff-f3e299cebe6d"}],"id":"53b8aa00-8cd1-409e-8d5e-46ae3769a8af","_postman_id":"53b8aa00-8cd1-409e-8d5e-46ae3769a8af","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"WebHooks & Logs","item":[{"name":"Webhooks disponíveis (Exemplo)","item":[{"name":"Signatário abre e-mail de solicitação","id":"fc8f7042-1408-4430-a503-9b61f8cb41e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"document_key\":\"jPD4r9XZQ049MlxWRM7LonLoTzQtMDaY\",\r\n \"signing_key\":\"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG\",\r\n \"status\":\"Open\",\r\n \"webhook_type\":\"REQUESTS_EMAIL_OPENED\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://seulink.com.br/abre-email.php","description":"Este webhook é disparado sempre que o signatário que recebeu a solicitação de assinatura abre o e-mail de solicitação.
\nÉ importante ressaltar que esta ação é rastreada por um pixel, portanto se o destinatário abrir várias vezes o e-mail, ou até APÓS assinar, você vai continuar recebendo as chamadas de leitura do e-mail.
\nEsta chamada se diferencia das demais pois o tipo de webhook é o REQUESTS_EMAIL_OPENED, utilizado exclusivamente para abertura de e-mails.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["abre-email.php"],"host":["seulink","com","br"],"query":[{"disabled":true,"description":{"content":"A document key do documento relacionado a solicitação de assinatura que foi lida.
\n","type":"text/plain"},"key":"document_key","value":"dYXBUw8WZOQ1hoVJnNzkvU28od2IYell"},{"disabled":true,"description":{"content":"Chave única da solicitação que deu origem ao evento
\n","type":"text/plain"},"key":"signing_key","value":"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG"},{"disabled":true,"description":{"content":"Status da chamada, no caso \"Open\" pois o e-mail foi aberto.
\n","type":"text/plain"},"key":"status","value":"Open"},{"disabled":true,"description":{"content":"Tipo do webhook recebido, no caso de leitura de e-mail de solicitação.
\n","type":"text/plain"},"key":"webhook_type","value":"REQUESTS_EMAIL_OPENED"}],"variable":[]}},"response":[],"_postman_id":"fc8f7042-1408-4430-a503-9b61f8cb41e6"},{"name":"Visualizar solicitação de assinatura","id":"0e4cbea8-a086-4617-b50f-aa58f811a321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"document_key\":\"jPD4r9XZQ049MlxWRM7LonLoTzQtMDaY\",\r\n \"signing_key\":\"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG\",\r\n \"status\":\"Open\",\r\n \"webhook_type\":\"REQUESTS_UPDATED\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://seulink.com.br/visualiza-assinatura.php","description":"Este webhook é disparado sempre que o signatário visualiza a solicitação de assinatura e o documento (Abre a página da web que mostra o arquivo).
\nÉ importante ressaltar que, mesmo com o documento assinado esta chamada continua sendo realizada, então se o signatário abrir a solicitação APÓS assinar para baixar o documento, uma nova chamada será realizada.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["visualiza-assinatura.php"],"host":["seulink","com","br"],"query":[{"disabled":true,"description":{"content":"A document key do documento relacionado a solicitação de assinatura que foi lida.
\n","type":"text/plain"},"key":"document_key","value":"dYXBUw8WZOQ1hoVJnNzkvU28od2IYell"},{"disabled":true,"description":{"content":"Chave única da solicitação que deu origem ao evento
\n","type":"text/plain"},"key":"signing_key","value":"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG"},{"disabled":true,"description":{"content":"Status da chamada, representa que a solicitação foi aberta (Visualizada) no navegador.
\n","type":"text/plain"},"key":"status","value":"Open"},{"disabled":true,"description":{"content":"Tipo de webhook, neste caso representa qualquer alteração em uma solicitação de assinatura.
\n","type":"text/plain"},"key":"webhook_type","value":"REQUESTS_OPENED"}],"variable":[]}},"response":[],"_postman_id":"0e4cbea8-a086-4617-b50f-aa58f811a321"},{"name":"Alteração de solicitação de assinatura","id":"fdd8349e-ea48-42d1-858e-766108529ebf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"document_key\":\"5XkZCSAqZlyX1DcNb0lhyCiJr7MDiK89\",\r\n \"signing_key\":\"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG\",\r\n \"status\":\"Signed\",\r\n \"webhook_type\":\"REQUESTS_UPDATED\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://seulink.com.br/altera-assinatura.php","description":"Este webhook é disparado sempre que a solicitação de assinatura tem alguma alteração, como ser assinada, cancelada ou recusada.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["altera-assinatura.php"],"host":["seulink","com","br"],"query":[{"disabled":true,"description":{"content":"A document key do documento relacionado a solicitação de assinatura que foi lida.
\n","type":"text/plain"},"key":"document_key","value":"dYXBUw8WZOQ1hoVJnNzkvU28od2IYell"},{"disabled":true,"description":{"content":"Chave única da solicitação que deu origem ao evento
\n","type":"text/plain"},"key":"signing_key","value":"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG"},{"disabled":true,"description":{"content":"Status da chamada, no caso \"Signed\" significa que a solicitação foi assinada, este ainda poderia ser: \"Declined\" para recusada pelo signatário ou \"Cancelled\" para cancelada por alugém da empresa.
\n","type":"text/plain"},"key":"status","value":"Signed"},{"disabled":true,"description":{"content":"Tipo de webhook, neste caso representa qualquer alteração em uma solicitação de assinatura.
\n","type":"text/plain"},"key":"webhook_type","value":"REQUESTS_UPDATED"}],"variable":[]}},"response":[],"_postman_id":"fdd8349e-ea48-42d1-858e-766108529ebf"},{"name":"Solicitação em cadeia finalizada","id":"f7324193-c421-4536-a318-8e05fe6fea22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"document_key\":\"5XkZCSAqZlyX1DcNb0lhyCiJr7MDiK89\",\r\n \"signing_key\":\"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG\",\r\n \"status\":\"Signed\",\r\n \"webhook_type\":\"REQUESTS_CHAIN_UPDATED\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://seulink.com.br/altera-assinatura.php","description":"Este webhook é disparado sempre que um conjunto de solicitações é finalizado.
\nUm documento pode precisar ser assinado para várias pessoas, neste caso, o documento só é \"Finalizado\" realmente quando todas as pessoas respondem a solicitação, seja recusando ou assinando o documento.
\nQuando a última pessoa responde e o PlugSign verifica que não existe mais nenhuma solicitação sequencial ou pendente, ele \"Finaliza\" a solicitação e envia o link do arquivo para todos os signatários, neste momento que este webhook é ativado.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["altera-assinatura.php"],"host":["seulink","com","br"],"query":[{"disabled":true,"description":{"content":"A document key do documento relacionado a solicitação de assinatura que foi lida.
\n","type":"text/plain"},"key":"document_key","value":"dYXBUw8WZOQ1hoVJnNzkvU28od2IYell"},{"disabled":true,"description":{"content":"Chave única da solicitação que deu origem ao evento
\n","type":"text/plain"},"key":"signing_key","value":"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG"},{"disabled":true,"description":{"content":"Representação de que a solicitação em cadeia foi finalizada (Não restam solicitações pendentes para o arquivo).
\n","type":"text/plain"},"key":"status","value":"Signed"},{"disabled":true,"description":{"content":"Tipo do webhook que sinaliza a finalização das solicitações para um documento, ou seja, não restam mais solicitações de assinatura pendentes para este documento.
\n","type":"text/plain"},"key":"webhook_type","value":"REQUESTS_CHAIN_UPDATED"}],"variable":[]}},"response":[],"_postman_id":"f7324193-c421-4536-a318-8e05fe6fea22"}],"id":"0184fc50-8dbf-4239-b3d4-96799da942c6","description":"Exemplo dos webhooks disponíveis e de seus retornos no sistema.
\n","_postman_id":"0184fc50-8dbf-4239-b3d4-96799da942c6","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Criação e edição de webhooks","item":[{"name":"Create Webhook","id":"78aea0fd-7951-49e1-a9ab-0cd502bc1958","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso cadastrado
\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/webhooks?url=https://seudominio.com.br/webhook&type=REQUESTS_CHAIN_UPDATED","description":"Cria um webhook para envio de notificações do sistema sobre solicitações e documentos.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","webhooks"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório] O endereço do seu sistema para o qual este webhook deve enviar os dados de resposta
\n","type":"text/plain"},"key":"url","value":"https://seudominio.com.br/webhook"},{"description":{"content":"[Obrigatório] O tipo de webhook que será criado, selecione um dentre os 4 disponíveis (REQUESTS_EMAIL_OPENED, REQUESTS_UPDATED, REQUESTS_CHAIN_UPDATED, REQUESTS_OPENED)
\n","type":"text/plain"},"key":"type","value":"REQUESTS_CHAIN_UPDATED"},{"disabled":true,"description":{"content":"[Opcional] Status de atividade do webhook, sendo 1 para ativo e 0 inativo
\n","type":"text/plain"},"key":"status","value":"1"}],"variable":[]}},"response":[],"_postman_id":"78aea0fd-7951-49e1-a9ab-0cd502bc1958"},{"name":"Edit Webhook","id":"39f8b68a-3270-4385-abf0-5b3c5dccce33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso cadastrado
\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/webhooks/{{id}}?url=https://seudominio.com.br/webhook&status=1","description":"Altera o estado de um webhook do sistema, para isto é necessário passar o ID do webhook na URL.
\nNo momento não é possível apagar um webhook, caso precise interrompe-lo, atualize seu status para 0.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","webhooks","{{id}}"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório] O endereço do seu sistema para o qual este webhook deve enviar os dados de resposta
\n","type":"text/plain"},"key":"url","value":"https://seudominio.com.br/webhook"},{"description":{"content":"[Opcional] Status de atividade do webhook, sendo 1 para ativo e 0 inativo
\n","type":"text/plain"},"key":"status","value":"1"}],"variable":[]}},"response":[],"_postman_id":"39f8b68a-3270-4385-abf0-5b3c5dccce33"},{"name":"Get webhooks","id":"989d5956-d15d-4351-a51e-95076d4e061e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","description":"Seu token de acesso cadastrado
\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/webhooks","description":"Lista todos os webhooks cadastrados na conta da empresa (Os webhooks são gerenciados a nível de empresa, não de usuário).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","webhooks"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"989d5956-d15d-4351-a51e-95076d4e061e"}],"id":"5716a8a4-2379-4a31-aba9-4c0a10b8a6a0","description":"Permite que você crie e gerencie os webhooks cadastrados no sistema diretamente via API, utilize o Create para criar os 4 webhooks permitidos, o delete para apagar caso precise e o GET para listar todos.
\n","_postman_id":"5716a8a4-2379-4a31-aba9-4c0a10b8a6a0","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"Get logs","id":"c1206afc-75fb-4984-9d73-188da3d1d593","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"[Obrigatório] Seu token de acesso da API
\n"},{"key":"Accept","value":"application/json","description":"[Opcional] Retorno preferido da rota.
\n","type":"text"}],"url":"https://app.plugsign.com.br/api/logs?url=https://app.plugsign.com.br/api/requests/documents&method=POST&status=500&created_at_start=2023-11-12 15:08:50&created_at_end=2023-11-23 11:00:00","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","logs"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Opcional] URL do endpoint que foi acionado.
\n","type":"text/plain"},"key":"url","value":"https://app.plugsign.com.br/api/requests/documents"},{"description":{"content":"[Opcional] Método que foi utilizado na requisição (Ex: POST, GET, PUT).
\n","type":"text/plain"},"key":"method","value":"POST"},{"description":{"content":"[Opcional] Status da requisição (Ex: 200, 500).
\n","type":"text/plain"},"key":"status","value":"500"},{"description":{"content":"[Opcional] Data e hora de início da busca.
\n","type":"text/plain"},"key":"created_at_start","value":"2023-11-12 15:08:50"},{"description":{"content":"[Obrigatório caso passe start] Data e hora do final da busca.
\n","type":"text/plain"},"key":"created_at_end","value":"2023-11-23 11:00:00"}],"variable":[]}},"response":[],"_postman_id":"c1206afc-75fb-4984-9d73-188da3d1d593"},{"name":"Get Logs Webhooks","id":"2a948289-882d-4f65-8281-57a9a9256834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.plugsign.com.br/api/webhooks/notifications","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","webhooks","notifications"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a948289-882d-4f65-8281-57a9a9256834"}],"id":"25a6cc8f-d293-4145-8075-d62920f97fa0","description":"Com os Webhooks do PlugSign você consegue receber as informações sobre as solicitações de assinatura que enviou via API e front-end.
\nPara utilizar os WebHooks é necessário acessar o painel de controle da conta em questão e nas configurações cadastrar os links para os quais quer que realizemos o disparo das informações.
\nPara isto acesse o sistema com a conta de administrador e acesse o menu \"Configurações\" e em seguida a opção \"API Webhooks\".
\nApós acessar o ambiente você poderá cadastrar os 4 webhooks disponíveis para que todos os eventos desta empresa sejam disparados.
\n\n\nAtenção! Os webhooks são disparados a nível de empresa, portanto caso esteja implementando o PlugSign para vários clientes, será necessário cadastrar os links para disparos para cada empresa individualmente!
\n
Atualmente estão disponíveis 4 webhooks (Fica a seu critério se vai utilizar um endpoint só para receber todos ou se quer separar), cada um envia um tipo de chamada diferente, sendo elas:
\n* Signatário abre e-mail de solicitação: O signatário para o qual foi enviada a solicitação leu o e-mail com a mesma (Acionada sempre que o e-mail for aberto, mesmo que repetidas vezes).
* Visualizar solicitação de assinatura: Signatário abre a página com a solicitação e visualiza o documento (Aciona sempre que ele recarrega a página, caso não assine na hora e abra novamente em outro momento será acionado novamente).
* Alteração de solicitação de assinatura: Houve alguma mudança na solicitação de assinatura, seja porque foi assinada, recusada ou cancelada.
* Solicitação em cadeia finalizada: Uma solicitação que possuía múltiplos signatários (Em cadeia ou não) foi finalizada e não restam mais solicitações pendentes para este documento.
\n\nATENÇÃO! Todos os endpoints tem que estar habilitados para receber chamadas externas, sem autenticação por meio de chamadas com POST e com acesso seguro (HTTPS), no ato do cadastro o PlugSign vai verificar os links cadastrados pingando os mesmos por meio de uma chamada segura.
\n
As chamadas feitas são realizadas por meio de um POST, ele será efetuado no momento em que o item ocorrer (Ex: O signatário acabou de abrir um e-mail de solicitação de assinatura).
\nLembre-se de que os envios são feitos por meio de uma fila de requisições, portanto o envio pode ter um pequeno atraso por conta de um possível fluxo de chamadas, normalmente este atraso não é maior do que um ou dois minutos.
\nExemplo de chamada enviada: {\"document_key\":\"dYXBUw8WZOQ1hoVJnNzkvU28od2IYell\",\"signing_key\":\"KJkJHKgJLJhgKJhgkJHGkJHGKJhgkJHG\",\"status\":\"Open\",\"webhook_type\":\"REQUESTS_EMAIL_OPENED\"}
\n* document_key: É o identificador do documento que teve alguma alteração ou relação com o pedido de assinatura, por exemplo, se receber uma chamada de que uma solicitação em cadeia foi finalizada, significa que todos os signatários preencheram e assinaram o documento que está disponível para download.
\n* signing_key: Chave única da solicitação que deu origem ao evento.
\n* status: Tipo de ação que aconteceu, podendo ser:
* Open: Foi uma abertura de e-mail e/ou página.
* Signed: Solicitação assinada.
* Declined: Solicitação recusada pelo signatário.
* Cancelled: Solicitação cancelada por alguém da empresa (Via API ou front-end).
* webhook_type: Tipo do webhook que foi recebido, diz respeito ao tipo de ação que foi realizada:
* REQUESTS_EMAIL_OPENED: E-mail de solicitação foi aberto e visualizado.
* REQUESTS_UPDATED: Houve alguma atualização na solicitação de assinatura, como ter sido aberta ou assinada.
* REQUESTS_CHAIN_UPDATED: Houve uma atualização na cadeia de solicitações (Ex: Foi finalizada).
Seu token de acesso
\n"}],"url":"https://app.plugsign.com.br/api/tags?name=Tag 1","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","tags"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Nome da TAG que será criada.
\n","type":"text/plain"},"key":"name","value":"Tag 1"}],"variable":[]}},"response":[{"id":"d5ae27a2-150d-46c3-8c1a-6dfd4a90ae6a","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso"}],"url":{"raw":"https://app.plugsign.com.br/api/tags?name=Tag 1","protocol":"https","host":["app","plugsign","com","br"],"path":["api","tags"],"query":[{"key":"name","value":"Tag 1","description":"[Obrigatório][String] Nome da TAG que será criada."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:17:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"46"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=wq0VrebiHDaYn0zlCh%2BdX4QqHcMpevyFpRbiV1a1rkVGIIjfVOPIJPsqstaPABrB8WmJ2CqeoMXsa%2F94x5yHNqcUzj%2FhlWW3A%2F4HawIrBPgIQSED0GWwtXSmdwicaFu466xq7fEm\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8666e0d2bf2adab1-MIA"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 5,\n \"name\": \"tag-1\",\n \"created_at\": \"2024-03-18 14:17:47\"\n }\n}"}],"_postman_id":"4b584803-b232-460e-a693-12f181e1fa7d"},{"name":"Add file to TAG","id":"09d41db4-3d83-4783-9610-1841b2d6d6ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso
\n"}],"url":"https://app.plugsign.com.br/api/tags/files?tag_id=5&file_id=124472","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","tags","files"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][INT] ID da TAG que será adicionada.
\n","type":"text/plain"},"key":"tag_id","value":"5"},{"description":{"content":"[Obrigatório][INT] ID do documento que será adicionado.
\n","type":"text/plain"},"key":"file_id","value":"124472"}],"variable":[]}},"response":[{"id":"c17e16c8-6509-460a-bafc-c761660ee239","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso"}],"url":{"raw":"https://app.plugsign.com.br/api/tags/files?tag_id=5&file_id=124472","protocol":"https","host":["app","plugsign","com","br"],"path":["api","tags","files"],"query":[{"key":"tag_id","value":"5","type":"text"},{"key":"file_id","value":"124472","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:21:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=E0kRkVGKmZEDiQ79Q46u87UmXydF6wwAYONdraDm%2FydYCpTyJ1Fi1xKnr%2FL%2B%2B1Ar09PTciiCQOzU2vIdCjClKGriQfHCrzzACS4SGZXWEhu4j5HLVpChr35JXpICpSQjLOlNf7W0\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8666e5ad8b7ddab1-MIA"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"ok\"\n}"}],"_postman_id":"09d41db4-3d83-4783-9610-1841b2d6d6ad"},{"name":"Update TAG","id":"5b7578eb-9d87-475d-a36d-5a2ce8d62576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso
\n"}],"url":"https://app.plugsign.com.br/api/tags/5?name=Novo nome","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","tags","5"],"host":["app","plugsign","com","br"],"query":[{"description":{"content":"[Obrigatório][String] Novo nome da TAG.
\n","type":"text/plain"},"key":"name","value":"Novo nome"}],"variable":[]}},"response":[{"id":"2c041b8a-59f3-49de-8693-1ce7b6c59da3","name":"Tag updated","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer 123456","type":"text","description":"Seu token de acesso"}],"url":{"raw":"https://app.plugsign.com.br/api/tags/5?name=Novo nome","protocol":"https","host":["app","plugsign","com","br"],"path":["api","tags","5"],"query":[{"key":"name","value":"Novo nome","description":"[Obrigatório][String] Novo nome da TAG."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:19:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=iWsn4buDqTIrk3Tu25XSdO%2BLMCvdayZJKciiapPL%2BoEmtzrjFk9Nl24PCqe%2BfVY7lnswLZ2Z%2FKZIlr71qsBUiUiAEdMAZJtqkXInyvjKO5ehnCS1KSKegNkLCEM2fwEUW%2FKzjdJm\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8666e30dadd3dab1-MIA"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Tag updated!\"\n}"}],"_postman_id":"5b7578eb-9d87-475d-a36d-5a2ce8d62576"},{"name":"Delete TAG","id":"722b2d4a-eca7-49b7-9a91-609d168fb869","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/tags/5","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","tags","5"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[{"id":"55c75678-bc41-4ecc-82e3-68e29b4b477e","name":"Erro ao deletar tag","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/tags/5"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:39:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=JZX9r6aBa9YRCdTIPn72TAsKS3CMZgPcrUwaj%2FRsOZtQQwoFS1niOaDfqBQH%2FYvrDV7wFNCG3ng9HwIewrWTfYBYsFSYBHhX6kZhl%2Fo541Fax3OJGSDQWsD%2FwTh6HscSD1F%2FJYqU\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"86670017287c7a08-GIG"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Remova o relacionamento da tag com o arquivo antes de excluir!\"\n}"},{"id":"14e3709c-9ef3-43ee-b2c8-d0ce8436780f","name":"Tag deletada","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer 123456","type":"text"}],"url":"https://app.plugsign.com.br/api/tags/5"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Mar 2024 17:39:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=JZX9r6aBa9YRCdTIPn72TAsKS3CMZgPcrUwaj%2FRsOZtQQwoFS1niOaDfqBQH%2FYvrDV7wFNCG3ng9HwIewrWTfYBYsFSYBHhX6kZhl%2Fo541Fax3OJGSDQWsD%2FwTh6HscSD1F%2FJYqU\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"86670017287c7a08-GIG"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Tag deletada!\"\n}"}],"_postman_id":"722b2d4a-eca7-49b7-9a91-609d168fb869"}],"id":"04121fe2-1d28-4516-bed0-dd48ca75afd5","_postman_id":"04121fe2-1d28-4516-bed0-dd48ca75afd5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}}},{"name":"https://app.plugsign.com.br/api/requests/documents","id":"f79e7a3a-b3b1-475e-ac83-62674faee948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer zcJLSJC2qqPc3CNeOFgcB6stYFYFR4iaGPtQe5v4vZ0vMg1nD6FrwVY8Jde52oK8ISRXA4cZ4Ixfrk9nbj0Y7vzVI1u5NCCurtxwiWpm3y55jt9NrVX1lGs9CPQDWLu84uH3eBDIpb5SXRkyBz5Airq1auIznqqc9jbgx8NYrLMVtUDeLfmjCh5LPcRnjac1Mxg6dVmWygxMEjkcci8LNm94dSj7URbA7IcmaoIBymCRSxhmHqFYaBOhBWMJMv5YHkHyLxC0QEzD8m7fKHuZejvvAUuhcfxrKYfTTbwY92tg9m3Xky1GJ2dR0tdLbzvgpo3x3NRJahFEbCRkg","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"document_key\": \"eFjF2Ktv4kvFopGxRDY3Wdn2fmSt7kFD\",\r\n \"message\": \"Mensagem de envio de documento para assinatura\",\r\n \"subject\": \"Teste teste\",\r\n \"width_page\": \"800\",\r\n \"observer\": [\"felipe@plugsign.com.br\"],\r\n \"chain\": true,\r\n \"due_months\": 12,\r\n \"recipients\": [\r\n {\r\n \"send_to\": \"contato@plugsign.com.br\",\r\n \"doubleauth\": false,\r\n \"allow_selfie\": false,\r\n \"allow_document\": true,\r\n \"allow_document_back\": false,\r\n \"signature_type\": \"Cliente 2\",\r\n \"reminder\": false,\r\n \"send_finished\": false,\r\n \"fields\": [\r\n \r\n {\r\n \"page\":1,\r\n \"type\": \"signature\",\r\n \"width\": 200,\r\n \"height\": 120,\r\n \"xPos\": 230,\r\n \"yPos\": 200\r\n },\r\n {\r\n \"page\":1,\r\n \"type\": \"text\",\r\n \"text\": \"Nome completo\",\r\n \"color\": \"#000000\", \r\n \"fontsize\": 14,\r\n \"width\": 200,\r\n \"height\": 120,\r\n \"xPos\": 400,\r\n \"yPos\": 200\r\n }\r\n ]\r\n },\r\n {\r\n \"send_to\": \"contato@plugsign.com.br\",\r\n \"allow_selfie\": false,\r\n \"allow_document\": true,\r\n \"allow_document_back\": true,\r\n \"signature_type\": \"Testemunha\",\r\n \"reminder\": false,\r\n \"send_finished\": true,\r\n \"fields\": [\r\n { \r\n \"type\": \"rubric\", \r\n \"width\": 300, \r\n \"height\": 75, \r\n \"xPos\": 100, \r\n \"yPos\": 100 \r\n } \r\n ]\r\n }\r\n \r\n \r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://app.plugsign.com.br/api/requests/documents","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","id":"c29b4ba5-0c3b-48c9-8098-e42bd485c3c4","name":"API PlugSign","type":"collection"}},"urlObject":{"protocol":"https","path":["api","requests","documents"],"host":["app","plugsign","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f79e7a3a-b3b1-475e-ac83-62674faee948"}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"c6368aa0-6fcc-4d5a-a822-ad3b81324a67","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc25d1d0-45f0-4295-aedd-41d7047a5110","type":"text/javascript","exec":[""]}}],"variable":[{"key":"TOKEN","value":"Bearer "},{"key":"reminder_id","value":"250"},{"key":"token_acesso","value":"123456"},{"key":"tag_id","value":"5"}]}