WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-05 01:07:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
be795859cd3b929f89811236c3ecb06151c63af2
OpenSign/assets/js/2c586be5.417a4dcd.js
T

1 line
14 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>x});var i=a(85893),r=a(11151),n=a(58219),l=(a(62316),a(51039)),t=a.n(l),o=(a(82723),a(9487)),c=(a(41429),a(5397)),m=a(4667),d=a(9472),p=a(85162);const h={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21v2zYQ/ivcfVoD+TVeWgjD0K7piqBFEywp9sExAlo6SUwkkiUp25qh/z4cZdmyky510U/DviQyeXfkPffyHNfgeGohnMK5isoCpbMwCyBGGxmhnVASQrjJkL01yB2yVoq9ubpgPM/V0rLSorHMKZaiRENSEpcsbu2xecW0UQsRC5mymDvOlsJlbM4tnk0YykjFGLNE5NhnN5mwLMlxJeY5sgJdpuL2nEQZ5jJkQkZ5aYWSTCVswY1QpW3sukqjDVjBH+go4ZgtheNkiXTp3BiZ4TJFUm1vyCLyjezZCCXZs/1beStPTj7rXPGYVapkOk6YkGwa47xM2dX5H7OfM+e0DQcD63gqZNrjWveVRmlFKnM+t/1IFQMyUCQDWitEZBTXeuBt6Dh5wTI06M1HXLLY8CVdMUVnGZcxi5SuWKR6yohYcocB0zxFJstijoY8cBkWfcZzq7ZGvM4GWpXQRU9ObiUEoDTFRih5EUMI3mVsEYAADH4p0brfVVxBuIZISUcb4Rq41rmIvOrg3lJCrMFGGRacvghyCEHN7zEiO9rQQU6gpV0KakfKOiNkCgEkyhTcQQjNTSEAXPFCkzAc5IWOE6gDcMI9Y2q7sjNl/cc20GRnL7O/y9p5x0IdgFTue+/1iVTrACg50NiOFW4MryAA4bCwz8Ns1PHYRKjobCy4yI/VvVc4R3zdLFCaeyB4cfQl7hWyOXoQdKbk0fqj8eloPDodjcnCpnS+H8Zm98hQilRyV5rGB552DTSF2jWwXdkaGNUBrI7UGU8mdQDVkVov6ajlkUqnr+oAsiOVJmf1rmIPWs3dXMXVXRuq+jnBtjSeE2wEqIkJgzGEzpToF6xW0jbhHQ+H9G+f2873SABjZssoQmuTMs+rnyD4UZ2wWabee1x+Zfdi/PcqWoyvKMFKc3SttixVmrznVI8A7bXQNaXbQVbIXEi8a2G7Gw+HdyPCtg5gMvzlMXwXcsFzEftx4EY9oPyBkKExyjzl7s657vGuOZ6uuio8TE1HAtEI+X3Yc7a73jhpMSqNcBWE0zWselyLXrMfTmf1LIBmIoEQtLL+xtxlEMLgEZ9aNAvf06frJmrwTeMC12KwGAEd1V7lmuBqENm70K7LafEBqc1t/O1KBSAoTBnyGI3HhqLw547s37VYtmT9FP/uMDtk1MNR8QmObClyj/U6pDdt+ctT0paRniCZrYctbWxZo0MEHR6Y7lJn26XbJj3ybXc8mfhG+nLkW+PpK9/sJmf1rJ7VhF2iPNAb7y81ymuRSp9vi9Ej7/30KqzfbiFqJkuaPw+0/ZQWMyX9UEubtH7aHzGrMRLJpmz6jGbRa1UgDdpJmbNcyAcb3soem14miYgEz9lfOLfC4W4oXS6Xj7Lrhdd5L1xWzplBrXbiqV/0KdjV2v54QTmAprCXyTWahYja1vKVowZeeLBpBjzyzaCN7Gbp9aESFWcuIpQWO+X75v3VR3baH0LQKaRvuPLg48Xbd5+u35FVKsUmRKP+sD/0XK2sK7jsHHTwxDmMbmco/v9F9F94EW16g8OVG+icC9lh2KavTw/fSbMAMmr84RTWa7L52eR1TctfSjTEGrMAKAAEseeMoO291I0esKI8a9Kod0Pnk3heNm38gCrroNV4E0Wo3b/Kdrnp6vL6BgKYb95yhYpJx/AlvfP4EkK4hVvwb0Ky0DwhuB8Ncy7T0jdIaOwSZfDSZft88+D5ZvPR6bNcVp1b7hNR4wr9JceeVPiVaugDVr9txZudrypssG2lKYSzuq7/AdcoykU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21v2zYQ/ivcfVoD+TVeWgjD0K7piqBFEywp9sExAlo6SUwkkiUp25qh/z4cZdmyky510U/DviQyeXfkPffyHNfgeGohnMK5isoCpbMwCyBGGxmhnVASQrjJkL01yB2yVoq9ubpgPM/V0rLSorHMKZaiRENSEpcsbu2xecW0UQsRC5mymDvOlsJlbM4tnk0YykjFGLNE5NhnN5mwLMlxJeY5sgJdpuL2nEQZ5jJkQkZ5aYWSTCVswY1QpW3sukqjDVjBH+go4ZgtheNkiXTp3BiZ4TJFUm1vyCLyjezZCCXZs/1beStPTj7rXPGYVapkOk6YkGwa47xM2dX5H7OfM+e0DQcD63gqZNrjWveVRmlFKnM+t/1IFQMyUCQDWitEZBTXeuBt6Dh5wTI06M1HXLLY8CVdMUVnGZcxi5SuWKR6yohYcocB0zxFJstijoY8cBkWfcZzq7ZGvM4GWpXQRU9ObiUEoDTFRih5EUMI3mVsEYAADH4p0brfVVxBuIZISUcb4Rq41rmIvOrg3lJCrMFGGRacvghyCEHN7zEiO9rQQU6gpV0KakfKOiNkCgEkyhTcQQjNTSEAXPFCkzAc5IWOE6gDcMI9Y2q7sjNl/cc20GRnL7O/y9p5x0IdgFTue+/1iVTrACg50NiOFW4MryAA4bCwz8Ns1PHYRKjobCy4yI/VvVc4R3zdLFCaeyB4cfQl7hWyOXoQdKbk0fqj8eloPDodjcnCpnS+H8Zm98hQilRyV5rGB552DTSF2jWwXdkaGNUBrI7UGU8mdQDVkVov6ajlkUqnr+oAsiOVJmf1rmIPWs3dXMXVXRuq+jnBtjSeE2wEqIkJgzGEzpToF6xW0jbhHQ+H9G+f2873SABjZssoQmuTMs+rnyD4UZ2wWabee1x+Zfdi/PcqWoyvKMFKc3SttixVmrznVI8A7bXQNaXbQVbIXEi8a2G7Gw+HdyPCtg5gMvzlMXwXcsFzEftx4EY9oPyBkKExyjzl7s657vGuOZ6uuio8TE1HAtEI+X3Yc7a73jhpMSqNcBWE0zWselyLXrMfTmf1LIBmIoEQtLL+xtxlEMLgEZ9aNAvf06frJmrwTeMC12KwGAEd1V7lmuBqENm70K7LafEBqc1t/O1KBSAoTBnyGI3HhqLw547s37VYtmT9FP/uMDtk1MNR8QmObClyj/U6pDdt+ctT0paRniCZrYctbWxZo0MEHR6Y7lJn26XbJj3ybXc8mfhG+nLkW+PpK9/sJmf1rJ7VhF2iPNAb7y81ymuRSp9vi9Ej7/30KqzfbiFqJkuaPw+0/ZQWMyX9UEubtH7aHzGrMRLJpmz6jGbRa1UgDdpJmbNcyAcb3soem14miYgEz9lfOLfC4W4oXS6Xj7Lrhdd5L1xWzplBrXbiqV/0KdjV2v54QTmAprCXyTWahYja1vKVowZeeLBpBjzyzaCN7Gbp9aESFWcuIpQWO+X75v3VR3baH0LQKaRvuPLg48Xbd5+u35FVKsUmRKP+sD/0XK2sK7jsHHTwxDmMbmco/v9F9F94EW16g8OVG+icC9lh2KavTw/fSbMAMmr84RTWa7L52eR1TctfSjTEGrMAKAAEseeMoO291I0esKI8a9Kod0Pnk3heNm38gCrroNV4E0Wo3b/Kdrnp6vL6BgKYb95yhYpJx/AlvfP4EkK4hVvwb0Ky0DwhuB8Ncy7T0jdIaOwSZfDSZft88+D5ZvPR6bNcVp1b7hNR4wr9JceeVPiVaugDVr9txZudrypssG2lKYSzuq7/AdcoykU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"}},f={},x=[{value:"Request",id:"request",level:2}];function b(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(s.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsxs)(s.strong,{children:["Upload you pdf in ",(0,i.jsx)(s.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]})}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"signature"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink