WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-06 17:57:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef74da02c706f6aefbfc8b41c4e95a6d7d7ca9ab
OpenSign/assets/js/38c56221.dfda5b34.js
T

1 line
15 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>g,toc:()=>j});var n=a(85893),r=a(11151),t=a(58219),i=(a(62316),a(51039)),l=a.n(i),o=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2rFS8hmDk2ar4+FbvkKbUPWCpTnrzItTrYfc2x7cN3ZP2hMTfqB+LOPARnSpUIxTmtCLkncTg4ZX89jN9PY+DHwfjcrDsE+On0eopcn5lH4zg6mjCTAbPcz4rn2v/eq7Gh7/v5tEWvnvTevr+y84WNkRrMv2zIMLKKr2t9+oX5n0nnto6YhzHNSP7vf/4rcoxux8f/DVy2Dhq7IVe0OuKpQtOjynSEYD3I3IP1EWPqLsLk0jF0l6pUAXUEd1zbOTaYKa24XJhswHqTivMz+FxRxO+dbX/niPEjrUlzlYG29oHlBAvYBltHHeM42Fj3ULBJCSBkrVeGIa8nGlnIVGhygvHhJcDo2AAxrG+c8gSo6hE2U1GoXMU5Y03g3WDYQlhZEpcCjkLj7FpJ8uBs1voA3uo2OsIaa6LQu2iIpJ/BR94vouMR41JApUlC2bKIBPhFwvA62A0jISPP4J5Xk5x8vwygC6BpTS4WWswkDz9oLPcwhZo3g2luWVDE/jx2Bnw9pGayQMSlIuqQ2M2AlwBuy7z78ANgVNxvAsv9M/tMmVeBVm/H4t9sNl8uO8c836tQtRk4auyBr4yHsUVM2fdf3nGNkqv9ZXFNbq3ycVB+Rec8Es+Hzo55mEA2bijfPmXgLqtVTsbTpA+ff3/1I6zh/Wwhkkmb+wUGz3+8+O7TT9efWO6w4HFJzxazRcRs1ocazUTV8T78tHInO8Rv2/Nv2/P/+fY8DPZAj2HeaFRmgpR7eLI83hh4660YvqRLsd3yBP+b07sdH//ckmPss0rEGp3iGojIJxlBAQ/gB+pEKr7rS+jkhtUzuW57fPEE8DGm6TnO85ya8CLtFGFdXV7fiERkw9pfW8k8Djf8kwBuRCpuxa2IPx/EGRFXfj7fCo2mbLGMSCDKZSyDLcdiCoQeIhAaPrBn45XpJlYeI6TeFf7Ljj3L8Ecumx+o+9OevL/5KsMQ25GaM7ja7Xb/AQsRBIM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2rFS8hmDk2ar4+FbvkKbUPWCpTnrzItTrYfc2x7cN3ZP2hMTfqB+LOPARnSpUIxTmtCLkncTg4ZX89jN9PY+DHwfjcrDsE+On0eopcn5lH4zg6mjCTAbPcz4rn2v/eq7Gh7/v5tEWvnvTevr+y84WNkRrMv2zIMLKKr2t9+oX5n0nnto6YhzHNSP7vf/4rcoxux8f/DVy2Dhq7IVe0OuKpQtOjynSEYD3I3IP1EWPqLsLk0jF0l6pUAXUEd1zbOTaYKa24XJhswHqTivMz+FxRxO+dbX/niPEjrUlzlYG29oHlBAvYBltHHeM42Fj3ULBJCSBkrVeGIa8nGlnIVGhygvHhJcDo2AAxrG+c8gSo6hE2U1GoXMU5Y03g3WDYQlhZEpcCjkLj7FpJ8uBs1voA3uo2OsIaa6LQu2iIpJ/BR94vouMR41JApUlC2bKIBPhFwvA62A0jISPP4J5Xk5x8vwygC6BpTS4WWswkDz9oLPcwhZo3g2luWVDE/jx2Bnw9pGayQMSlIuqQ2M2AlwBuy7z78ANgVNxvAsv9M/tMmVeBVm/H4t9sNl8uO8c836tQtRk4auyBr4yHsUVM2fdf3nGNkqv9ZXFNbq3ycVB+Rec8Es+Hzo55mEA2bijfPmXgLqtVTsbTpA+ff3/1I6zh/Wwhkkmb+wUGz3+8+O7TT9efWO6w4HFJzxazRcRs1ocazUTV8T78tHInO8Rv2/Nv2/P/+fY8DPZAj2HeaFRmgpR7eLI83hh4660YvqRLsd3yBP+b07sdH//ckmPss0rEGp3iGojIJxlBAQ/gB+pEKr7rS+jkhtUzuW57fPEE8DGm6TnO85ya8CLtFGFdXV7fiERkw9pfW8k8Djf8kwBuRCpuxa2IPx/EGRFXfj7fCo2mbLGMSCDKZSyDLcdiCoQeIhAaPrBn45XpJlYeI6TeFf7Ljj3L8Ecumx+o+9OevL/5KsMQ25GaM7ja7Xb/AQsRBIM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},f={},j=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function x(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,r.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,n.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,n.jsxs)(s.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,n.jsx)(s.a,{href:"https://app.opensignlabs.com",children:" https://app.opensignlabs.com"})," (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,n.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,n.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"note",children:"Note:"}),"\n",(0,n.jsx)(s.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})}),(0,n.jsx)("strong",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})}),(0,n.jsx)("span",{className:"openapi-schema__divider"}),(0,n.jsx)("span",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document created successfully!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink