Files
OpenSign/assets/js/e2a6fad1.fccbd2af.js
T

1 line
10 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6741],{57755:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>f,toc:()=>x});var i=s(85893),r=s(11151),t=s(58219),n=(s(62316),s(51039)),o=s.n(n),l=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const u={id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. 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 from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v2zYQ/ldufFoC2XLSbg/CMCxr2iJosQRIij04RkpTJ+kaiWRJyo4X+H8fjrIcOXGCDNjTsJdEvt/33fEj70WQpRfZVJwa1TaogxezROTolSMbyGiRiasK4Z1DGRB6Kzi5OANZ12bpofXoPAQDJWp0bKVxCXkfD+YrsM4sKCddQi6DhFA505YVfG3aOpCVLqSFcc2IlV/HcFWRh6LGO5rXCA2GyuR9ssI4CBUCaVW3nowGU8BCOjKt3wRfWfQJNPKW81EA31KQHIl9JSwpR3BSl8iufZmguEGO5xVqjufH1/paHx5+sbWROaxMCzYvgDRMc5y3JVycfpj9WIVgfZamPsiSdDmS1o6NRe2p1LWc+7EyTcoBmiJlWUPKGWltGmPYvDiACh3G8EpqyJ1ccoklBg9S56CMXYEyI+Mo1zJgAlaWCLpt5ui4g1BhMwZZe7MNEn3m0uPPb9ni4vTD4eG1FokwlgdERp/lIhOxZewRWFKo5qSlW4lEOPzeog+/m3wlsnuhjA6oA3/uGRmLvaqwiV+Mv8iEmX9DFUQirOOsgdCztqAaB1Y+ONKlSAQHk0FkYlPCOhGBwj7b9aP13KPXJux35Amg8y8WIJ2TK7F+KOBZnG7mDM+aTRkvcpiLLLgWo8Bbo33X9PFkwv92T9XpzuZhDr5VCr0v2rpe/SCSIejS2ppUnFz6zXddvxbxTswDf6HprQTvZGNj19U3Ov7rTi2OLxi51tX/OMDmaLSuHgUzYuxHPYh8LHYwJl2TxpsetpvjyeTmiLFdJ+Lt5Ken8J3phawpj0R0ZW5R/4uQoXPG7Wv3oblh+tCl51LvmgiTlk3XVDSKerHT7FDeNelRtY7CSmTTe3E3kpZGnT6bztazRHQ0KDJhjY8Vy1CJTKQvHGKPbhG3fXrfzU+8iq2kpXRxJDhpX9QlA9dhs1PaFiFp6RNyzk3nQ6tEEA+sQpmjiyiRLkx03uBxblFfUqkjmosj8fQCIg/ko7rvtCNrpvRH3pH4cjA63hOsZPmb8RF4i4qKzVKMgen90jTIF1jR1lCTvvXZtR7B9LwoSJGs4U+cewr4wPPL5fIJYgfR5yOFqp2DQ2sezMsojLAOvbY/DkQiArrGnxeX6Bak+oPzTKo0GqebVZcqrjo2kni6G9Fvj5149WpSqD0OlvPk48VneDOeiGSwHK8oOf189u79H5fvOSqvVzeio/FkPGERr2cj9SDR46dD4UwD2yV9xOXbE/z/q+M/8+rYcETAu5DaWpIeXCgdjU2ff4vMElEx42VTcX/P0b+4er1m8fcWHdPlLBE8CgY7kmXSUw3z3i2ueAW7rRpdcSVsXrdc0b63zDrpnU6UQhsG5k+ulB1evji/vBKJmG+eTI3J2YcDx7jJw2dXpGy58yGD3kYG3Xxw8b1KrwZV7FJrVyr/5cL3OvzCp+YTrn7dmneaZx028PXWPK/Zer3+G37dREo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={id:"API-docs/createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. 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/createdocumentwithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithbinary",permalink:"/docs/API-docs/createdocumentwithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. 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 from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v2zYQ/ldufFoC2XLSbg/CMCxr2iJosQRIij04RkpTJ+kaiWRJyo4X+H8fjrIcOXGCDNjTsJdEvt/33fEj70WQpRfZVJwa1TaogxezROTolSMbyGiRiasK4Z1DGRB6Kzi5OANZ12bpofXoPAQDJWp0bKVxCXkfD+YrsM4sKCddQi6DhFA505YVfG3aOpCVLqSFcc2IlV/HcFWRh6LGO5rXCA2GyuR9ssI4CBUCaVW3nowGU8BCOjKt3wRfWfQJNPKW81EA31KQHIl9JSwpR3BSl8iufZmguEGO5xVqjufH1/paHx5+sbWROaxMCzYvgDRMc5y3JVycfpj9WIVgfZamPsiSdDmS1o6NRe2p1LWc+7EyTcoBmiJlWUPKGWltGmPYvDiACh3G8EpqyJ1ccoklBg9S56CMXYEyI+Mo1zJgAlaWCLpt5ui4g1BhMwZZe7MNEn3m0uPPb9ni4vTD4eG1FokwlgdERp/lIhOxZewRWFKo5qSlW4lEOPzeog+/m3wlsnuhjA6oA3/uGRmLvaqwiV+Mv8iEmX9DFUQirOOsgdCztqAaB1Y+ONKlSAQHk0FkYlPCOhGBwj7b9aP13KPXJux35Amg8y8WIJ2TK7F+KOBZnG7mDM+aTRkvcpiLLLgWo8Bbo33X9PFkwv92T9XpzuZhDr5VCr0v2rpe/SCSIejS2ppUnFz6zXddvxbxTswDf6HprQTvZGNj19U3Ov7rTi2OLxi51tX/OMDmaLSuHgUzYuxHPYh8LHYwJl2TxpsetpvjyeTmiLFdJ+Lt5Ken8J3phawpj0R0ZW5R/4uQoXPG7Wv3oblh+tCl51LvmgiTlk3XVDSKerHT7FDeNelRtY7CSmTTe3E3kpZGnT6bztazRHQ0KDJhjY8Vy1CJTKQvHGKPbhG3fXrfzU+8iq2kpXRxJDhpX9QlA9dhs1PaFiFp6RNyzk3nQ6tEEA+sQpmjiyiRLkx03uBxblFfUqkjmosj8fQCIg/ko7rvtCNrpvRH3pH4cjA63hOsZPmb8RF4i4qKzVKMgen90jTIF1jR1lCTvvXZtR7B9LwoSJGs4U+cewr4wPPL5fIJYgfR5yOFqp2DQ2sezMsojLAOvbY/DkQiArrGnxeX6Bak+oPzTKo0GqebVZcqrjo2kni6G9Fvj5149WpSqD0OlvPk48VneDOeiGSwHK8oOf189u79H5fvOSqvVzeio/FkPGERr2cj9SDR46dD4UwD2yV9xOXbE/z/q+M/8+rYcETAu5DaWpIeXCgdjU2ff4vMElEx42VTcX/P0b+4er1m8fcWHdPlLBE8CgY7kmXSUw3z3i2ueAW7rRpdcSVsXrdc0b63zDrpnU6UQhsG5k+ulB1evji/vBKJmG+eTI3J2YcDx7jJw2dXpGy58yGD3kYG3Xxw8b1KrwZV7FJrVyr/5cL3OvzCp+YTrn7dmneaZx028PXWPK/Zer3+G37dREo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},x=[{value:"Request",id:"request",level:2}];function g(e){const a={a:"a",code:"code",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Create Document from binary"})}),"\n",(0,i.jsx)(o(),{method:"post",path:"/createdocumentwithbinary"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(a.code,{children:"multipart/form-data"}),". 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)(a.p,{children:(0,i.jsxs)(a.strong,{children:["Upload you pdf in ",(0,i.jsx)(a.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)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,i.jsxs)(s,{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)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.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)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.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 b(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]);