mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-30 21:44:56 +02:00
1 line
9.4 KiB
JavaScript
1 line
9.4 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>y,frontMatter:()=>u,metadata:()=>g,toc:()=>x});var t=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),n=a.n(r),c=(a(82723),a(9487)),m=(a(41429),a(5397)),o=a(4667),d=a(9472),p=a(85162);const u={id:"createtemplate",title:"Template Creation API",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 **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Template Creation API",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktPIzkQ/iuemssOMkkY5tSnYVmE0CJABLSHEI0cdyVtcNvGducxUf/3VTndoUmYEUh7XC6kq1yvz1VfeQ1RzAJkI4hYOi0iBhhzyDFIr1xU1kAGdwWyu0bNTj0KkrOTmwsmtLaLwKqAPrBomSQlMlmFaEv1U0w0sq1jzhaFkgUL6OfIRGATXaHzysTAptazGRr0IiozY7mVVYmkWKhYMOcxx6kymLMQfSVj5TH02L2zhoVKSgxhWultpE0ayhrOYoEpUY+x8iYwwSqjnitkBwft6Yv84IDFQkQmhWETpGpyKqbJBzvZTATprEl+g0OppooON656wMG6VIQ1FzlksAGk1QMHj88VhvinzVeQrUFaE9FE+imc00om0/5jIODXEGSBpaBfceUQMrCTR5QRODhPgaLCQNorUWLnVIhemRlwmFpfitiV4FKUTqdD6cc2d6g5XNn4YTc3GkVA5nGucMGEyVlQMwJIhS1w5Puvbkt9LMT2XrttWXO4v738qKsiRheyfn9lK69KMcOetCX5oqTRh44/4b1YdY1H8Gjx+6wUSicrDo+2MB3BmMOy1OTCpPvYOuWw8MI5zCGLvsKag4pYhreSf0mVgjVfTbi3ndccoor6lagmFHSOnprwYwgtH8NEHJ2L5U1y8zrmTjt3Qu9qajL2GJw1YdOjXwcD+rdDLa9GluZ7O8569Qn4fzUg0ubdzlYm4gx9Fwpl4vHXVFE6sgtazaHEEMTsLd0eTp8/5zgVlY77ELUV3zbYNFB9G3zbR+fCzIVWeWKwO/uE5lOKVWIsLLGLsyGVKmIBGfT3yCYxLTX1aA2V153+F871rENDHaPFJFCH9YVT/fkR1GOylJVXcTUkfDcQCqd+POGqOyFO/Y00Ik3Vy0Ph1GGkRIGDogoKFDn6lDVd2e0L+521Hdey1x4htXz0PorZYZi3SaPhjF/QQIcF3jPrLxP2amio8qlNMDUXf+3QDCljusf5EezvVxWYCknd1rPZsbQWd6xf7yBSkvy4d9Tuo82E9NiDeTBDW6Z9RttRK/MUsgdzyEbX06mSSmj2D06Cijj+owVksVjs9cWXZHOuYlFNmEdnX47PkjA1T9dq+/EFOET0ZbieDtHPlWw5+Beh+ulwv5l7IdPcI4FO87MRfd81Isi1kkjD9DKCJ+c3l+y4NwDeaf13pNy/vDg9uxqekVcans0VHfUGvQGJaORKYTqB3nwZ7d5xZ9P//5z6yHOqoZqIy9h3Wqi0+NOFrhveG+3unjGHgogxG8F6TSHuva5rEj9X6FeQjcYc5sIrwpO+at7yFBFl4jg43VzX4R3Fp+O62lDezg6qeWtxIiW6+Nuz4w5331wP74DDpHkIlmlBgRcLeiSKBWTwAA+QHpTkIVFwkq9BCzOr0iaCjV/6+xemEx3D",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,g={id:"API-docs/createtemplate",title:"Template Creation API",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 **templateId** 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:"Template Creation API",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 **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Template Creation API",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktPIzkQ/iuemssOMkkY5tSnYVmE0CJABLSHEI0cdyVtcNvGducxUf/3VTndoUmYEUh7XC6kq1yvz1VfeQ1RzAJkI4hYOi0iBhhzyDFIr1xU1kAGdwWyu0bNTj0KkrOTmwsmtLaLwKqAPrBomSQlMlmFaEv1U0w0sq1jzhaFkgUL6OfIRGATXaHzysTAptazGRr0IiozY7mVVYmkWKhYMOcxx6kymLMQfSVj5TH02L2zhoVKSgxhWultpE0ayhrOYoEpUY+x8iYwwSqjnitkBwft6Yv84IDFQkQmhWETpGpyKqbJBzvZTATprEl+g0OppooON656wMG6VIQ1FzlksAGk1QMHj88VhvinzVeQrUFaE9FE+imc00om0/5jIODXEGSBpaBfceUQMrCTR5QRODhPgaLCQNorUWLnVIhemRlwmFpfitiV4FKUTqdD6cc2d6g5XNn4YTc3GkVA5nGucMGEyVlQMwJIhS1w5Puvbkt9LMT2XrttWXO4v738qKsiRheyfn9lK69KMcOetCX5oqTRh44/4b1YdY1H8Gjx+6wUSicrDo+2MB3BmMOy1OTCpPvYOuWw8MI5zCGLvsKag4pYhreSf0mVgjVfTbi3ndccoor6lagmFHSOnprwYwgtH8NEHJ2L5U1y8zrmTjt3Qu9qajL2GJw1YdOjXwcD+rdDLa9GluZ7O8569Qn4fzUg0ubdzlYm4gx9Fwpl4vHXVFE6sgtazaHEEMTsLd0eTp8/5zgVlY77ELUV3zbYNFB9G3zbR+fCzIVWeWKwO/uE5lOKVWIsLLGLsyGVKmIBGfT3yCYxLTX1aA2V153+F871rENDHaPFJFCH9YVT/fkR1GOylJVXcTUkfDcQCqd+POGqOyFO/Y00Ik3Vy0Ph1GGkRIGDogoKFDn6lDVd2e0L+521Hdey1x4htXz0PorZYZi3SaPhjF/QQIcF3jPrLxP2amio8qlNMDUXf+3QDCljusf5EezvVxWYCknd1rPZsbQWd6xf7yBSkvy4d9Tuo82E9NiDeTBDW6Z9RttRK/MUsgdzyEbX06mSSmj2D06Cijj+owVksVjs9cWXZHOuYlFNmEdnX47PkjA1T9dq+/EFOET0ZbieDtHPlWw5+Beh+ulwv5l7IdPcI4FO87MRfd81Isi1kkjD9DKCJ+c3l+y4NwDeaf13pNy/vDg9uxqekVcans0VHfUGvQGJaORKYTqB3nwZ7d5xZ9P//5z6yHOqoZqIy9h3Wqi0+NOFrhveG+3unjGHgogxG8F6TSHuva5rEj9X6FeQjcYc5sIrwpO+at7yFBFl4jg43VzX4R3Fp+O62lDezg6qeWtxIiW6+Nuz4w5331wP74DDpHkIlmlBgRcLeiSKBWTwAA+QHpTkIVFwkq9BCzOr0iaCjV/6+xemEx3D",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},j={},x=[{value:"Request",id:"request",level:2}];function f(e){const s={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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Template Creation API"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,t.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,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); |