WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-09 19:27:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c4fb901174b535b11a91c20fca670b375880ece9
OpenSign/assets/js/bbdfc22d.63ecb8be.js
T

1 line
16 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=a(85893),i=a(11151),r=a(58219),n=(a(62316),a(51039)),t=a.n(n),m=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),o=a(9472),p=a(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91v2zYQ/1e4e1oNxV9x00IYhn53QYslWFzswTEMWjpLTCSSJSk7nqH/fThKsmUnTeai2Mv2ksjHu+N98X53G3A8sRBOYIy5zrhDC9MAYrSREdoJJSGEcYqsOWZvDXKis9eX54xnmVpZVlg0ljnFIjpEFhXWqVz8xecZMtcoDtgqFVHKLJolMm7ZPCtQGyGdZQtlWIISDXdCJixWUZEjHayES5k2GONCSIyZdaaIXGHQdtkXrSSzRRShtYsi295UmSGUDJhL0Rtq0BVGWsZZIcXXAlmn03DPRNzpMJdyxyIu2RzJnZi8qQ3CljlzTmdKesVWYyQWgphrXV12La/lF50pHrO1KpiOF0xINul03uG8SNjluw+dzvTn1Dltw16Pa91VGqUVicz43HYjlfdIOF/0iJaLyCiudS8maR0vnrEUDXrVZGxs+IqtRJygs4zLmEVKr1mkTpQRseQOA6Z5gkwW+RwNUwuyO+8ynlm1VeJlyLGzEXFcvvvQvZYQgNI+HUqexxBCldrGUQjA4NcCrXuj4jWEG4iUdCgdfXKtMxF50d6NpRLagI1SzDl9ubVGCEHNbzByEIA2dJETaOl0ITJscVlnhEwggIUyOXcQQmUoBIB3PNfEXJMYykjFGDOvogzACfeEri1lp8v6j21CSY9U7nvVeNHy4D19l6a2hjIAKg40tqWMG8PXEIBwmNun42zU8bGJUNHdmHORHSt7o3CO+KoiUJn7yPL8aCNuFLI5+qjqVMmj5QfD08FwcDoYkob66Xx/GKvTIzPqeK69/TxpC1ePtC28pWyFB2UAd0fKDEejMoD1kVIv6KrVkUKnL8sA0iOFRmfl7rUe9JnZXMXrWZOm8inG5lk8xVgxUAcTBmMInSnQE6xW0lapHfb79O8ACvcghvBoCz/Z+icIflQbrMjUeO/X1q6S3qTD36yWeZRSOeVo7X5FPSDyhAPtuAmZCYmzJiizYb8/e06RKwMYPRScK5WjSwm/VygdWxklk4DpDLlF5sya8YQLyeh68wNjhcYo87jXx1n2WBBG/f5ssA3C8/tBOJdLnonYTx1jdYvy3/W0fb2rridT73LfsauGC6Ji8uew52ybXjlpMSqMcGsIJxu4O+FanFTn4WRaTqnqXKpoQNDKeou5SyGE3r15wY99BFmTDRQmgxAenYK4Fr3lAMrgkNs6ngiZnDwqNd0ZfkXBreK3Z/6u5WvxCann19FpcwUgKKkp8hiNjyTl7I/d6PO+iXwzujw4jexCfDhfNOPF3sRwOIA/MAO0RoBJg+YeoLf4/ADkbl1sQHSLoS1YbKHipFVphFkNZA08CA1HIw8rLwYeKE5f+tY/Oiun5bSkwC2Uj3Lt+YVGeSWSanFYDu45OU6FZcL642bgrjYNWg4OpPcHcTok+ml30Azl1Qur5nF6/TTU046QCXlrw2t5wiYXi4WIBM/Ynzi3wuFuLF+tVvdK65mX+ShcWsyZQa127Ikn+vprS21/PKP8o8ntxeIKzVJEWJfzN67qeeZe3Td45PtGk9Wa9OpQiN5xJiKUFlsv/fXHy89syU67fQha7+gfGN37fP72/e9X70kvvdsqSYNuv9v3s4uyLueyddXbavcb7yr7YOrdNsH/F8r/5kJZ9xKHd66nMy489vii3NSwMTlcM6cBpIQr4QQ2G1L5xWRlSeSvBRoCpWkAS24EVYaHpKBp1tS9bnFNlVkV3smY7if2rKj6/gESE9ZUEq+jCLV7lLcNfZcXV2MIYF6vwrmKScbwFa3JfAUhXMM1+JWaNFQLGPfDdcZlUvimCpVewhheuHQfoG49QNUfrb7M5bpl5T5yVa7QX3LsQYFfqJQ/4frXLXt18k2BOrYNN6VwWpbl324DTxE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91v2zYQ/1e4e1oNxV9x00IYhn53QYslWFzswTEMWjpLTCSSJSk7nqH/fThKsmUnTeai2Mv2ksjHu+N98X53G3A8sRBOYIy5zrhDC9MAYrSREdoJJSGEcYqsOWZvDXKis9eX54xnmVpZVlg0ljnFIjpEFhXWqVz8xecZMtcoDtgqFVHKLJolMm7ZPCtQGyGdZQtlWIISDXdCJixWUZEjHayES5k2GONCSIyZdaaIXGHQdtkXrSSzRRShtYsi295UmSGUDJhL0Rtq0BVGWsZZIcXXAlmn03DPRNzpMJdyxyIu2RzJnZi8qQ3CljlzTmdKesVWYyQWgphrXV12La/lF50pHrO1KpiOF0xINul03uG8SNjluw+dzvTn1Dltw16Pa91VGqUVicz43HYjlfdIOF/0iJaLyCiudS8maR0vnrEUDXrVZGxs+IqtRJygs4zLmEVKr1mkTpQRseQOA6Z5gkwW+RwNUwuyO+8ynlm1VeJlyLGzEXFcvvvQvZYQgNI+HUqexxBCldrGUQjA4NcCrXuj4jWEG4iUdCgdfXKtMxF50d6NpRLagI1SzDl9ubVGCEHNbzByEIA2dJETaOl0ITJscVlnhEwggIUyOXcQQmUoBIB3PNfEXJMYykjFGDOvogzACfeEri1lp8v6j21CSY9U7nvVeNHy4D19l6a2hjIAKg40tqWMG8PXEIBwmNun42zU8bGJUNHdmHORHSt7o3CO+KoiUJn7yPL8aCNuFLI5+qjqVMmj5QfD08FwcDoYkob66Xx/GKvTIzPqeK69/TxpC1ePtC28pWyFB2UAd0fKDEejMoD1kVIv6KrVkUKnL8sA0iOFRmfl7rUe9JnZXMXrWZOm8inG5lk8xVgxUAcTBmMInSnQE6xW0lapHfb79O8ACvcghvBoCz/Z+icIflQbrMjUeO/X1q6S3qTD36yWeZRSOeVo7X5FPSDyhAPtuAmZCYmzJiizYb8/e06RKwMYPRScK5WjSwm/VygdWxklk4DpDLlF5sya8YQLyeh68wNjhcYo87jXx1n2WBBG/f5ssA3C8/tBOJdLnonYTx1jdYvy3/W0fb2rridT73LfsauGC6Ji8uew52ybXjlpMSqMcGsIJxu4O+FanFTn4WRaTqnqXKpoQNDKeou5SyGE3r15wY99BFmTDRQmgxAenYK4Fr3lAMrgkNs6ngiZnDwqNd0ZfkXBreK3Z/6u5WvxCann19FpcwUgKKkp8hiNjyTl7I/d6PO+iXwzujw4jexCfDhfNOPF3sRwOIA/MAO0RoBJg+YeoLf4/ADkbl1sQHSLoS1YbKHipFVphFkNZA08CA1HIw8rLwYeKE5f+tY/Oiun5bSkwC2Uj3Lt+YVGeSWSanFYDu45OU6FZcL642bgrjYNWg4OpPcHcTok+ml30Azl1Qur5nF6/TTU046QCXlrw2t5wiYXi4WIBM/Ynzi3wuFuLF+tVvdK65mX+ShcWsyZQa127Ikn+vprS21/PKP8o8ntxeIKzVJEWJfzN67qeeZe3Td45PtGk9Wa9OpQiN5xJiKUFlsv/fXHy89syU67fQha7+gfGN37fP72/e9X70kvvdsqSYNuv9v3s4uyLueyddXbavcb7yr7YOrdNsH/F8r/5kJZ9xKHd66nMy489vii3NSwMTlcM6cBpIQr4QQ2G1L5xWRlSeSvBRoCpWkAS24EVYaHpKBp1tS9bnFNlVkV3smY7if2rKj6/gESE9ZUEq+jCLV7lLcNfZcXV2MIYF6vwrmKScbwFa3JfAUhXMM1+JWaNFQLGPfDdcZlUvimCpVewhheuHQfoG49QNUfrb7M5bpl5T5yVa7QX3LsQYFfqJQ/4frXLXt18k2BOrYNN6VwWpbl324DTxE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,i.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create Template"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/createtemplate"}),"\n",(0,l.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,l.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,l.jsxs)(s.p,{children:["Upload you pdf in ",(0,l.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,l.jsx)(s.strong,{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,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"stamp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(r.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Template created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink