WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 01:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
e9c2b4134ef7de85e819f95f9ee690c328af2ecf
OpenSign/assets/js/bbdfc22d.a84b1389.js
T

1 line
31 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=s(85893),i=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztGmtvGzfyr0z5pY2wki3HeZxwOFwevTbow0HjoDhYRkrtjrSMd8kNybW8NfTtfsn9tPslh+FjdyVLdpIWre+gL7aWHA5nhkPO85pZvjBscsZOsawKbtGw84RlaFItKiuUZBN2miPEaXihkdM4PHv9CnhRqKWB2qA2YBWkNImQ1saqUvzKZwWCjYgTWOYizcGgvkTgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEmliKWwOlcYM50JiBsbqOrW1RjOCt5WSYOo0RWPmddHu5MkQSiZgc3SEarS1lgY41FJ8qBEGgwj9TmSDAdicW0i5hBkSOxlxEwjCHjkzTnNKOsSmwlTMBQEHXKOpnMq3VaF4Bo2qocrmICSoWsPZYPASZ/UC3r4aDM6/yq2tzOTggFfVSFUojVjIgs/MKFXlQUaAVTZ/ADlqdJiItEzzJSxFtkBrgMsMUlU1kKqh0iKT3GICFV8gyLqcoQY1JyrLEfDCqBaJW0NsPD4miNcv/+GIHgyeY6F66DWCqatKaYsZ8UAMRzlMBgNa80KVpZJQcc1LtKQCah4RTAhgSGJuKpwMBvBKZiIlNXCYaLSDHnlQIp5A3wS5etA1lmTQIeJmyaWlY6oKnqID1UhHYsUlriO+SqAhxC9RqkhBrrT4VUnLCyfKS9RWpLyAVCmdCeko9RIEY7l2alkpIW0cDTvAP4Nga+OJyMIpE2kZiaUU0s0YhEte1GgCVcsEcqLqJ6w0GqdeAa/NHU05ikW+cz+eva+NXUMMtSEy+1SEvTR+qIXGzIkXndjmvDAIYr4my5JfYG83UO4N4MUInjeQ4ZzXhU1A2C8NWF3jCH5UFnhVFSJ1l53uMakypys6dKccFCIQInnpzvi1VpciQ7qRmZjPUaO0QJMORdTCQB0pY+UWEHul0kQjl6Bk76DHIxgM2r2div7yyy9TeT2VAFNGtEzZZMpakClLwM+Rik3ZZJxAGLiasgk8PHoSARr6fnz0NH4v6Xs8Po7fOX0fjadyFTY9csRYXla3EELTvz8R8dMfnaFBtzONRTWgQTo/D0szJHoabcmiiVXH0ENiSEhhBS/Mbp4ixP1jq6Nsg7Nj4gxLLordbLnp+8dTIGuDoUej7p7t4MejuG/s+F8b3Dwmbt6rGVhhi1tYakHuH1890jaYe0LMpaqsuGx2sxYA7h9jLWEbbD0ltjJubzkumr1/DAWq4kQweH7u8Hg4fjQ8Ojw67kHMlS55ACjLYZYNm6Zppgw6iYDjn2xfQEfmL9o/b6vJx5xrVW5xbpzv0UEFX8D9jg7BD+QGzKKF7Ly1zj31VK7bcKsy3nxpPKq4NBhpD9+5Yk2PTDdFdDTk1aa5EmkgnmCC4GFGzuSIhDAkOWYHP/xw4CWTdIPDsgzi8mdBo/Q9dJLsj5blKMtGm7B9gfdHS8iyBLaMb5/IMijLcte4nyAVn8q/jFzccGVn6mq3ageA+6fdHWFbFTwYhTiXCxkmgnbABoDGRV1wjVfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPjqJLieD4JSEj3rCGjk7nU3yOwj0bjAK4fDx6xEjMhC8GjqNKc41UW55HkqWTQhFDGJ/0p5JSiGKNBaN4o2Ha0TMZXjQ/fO55he3Ko5EeL+qU6PsjjpQw6aPpuykgfDy+bY/VY2Rz1l5+0agwWmFrPeWti2GM57WsYzkjQBu5ClIy8XGRZ8hkU31yMuHGOPVZoohfRERDEcRnxull9tzIbJ1Ral9kz0tSm+flEno9SgECbGousi6K8OMZzLREj0KYgZQlwAs/b13qbkXkq9+I6OcjO8M2jXCeMG4tItIZ6Tabx9QdZ37EBw4ADb8DlutmuDwMLayfTlQjhKIUVZl73URsQaJVYGK9gXF62k3FTcoX+6N3bgV3fsELJDOzaYyrGLQDOtqkwtpbvlsN33CSD375r3KPst13zNrHi433KNIlX9a7TFohCotyXtFTK779AITuj9phSCXyQM8DTFymK28YCPXTSveSYUzGprldz9hPeh7t/5blD3B5wxMfxxp9yn7c866akc+0RH6VORu7IcpTvP+3a6gaztxxBMnGQJU5XLsyv5KmMT5nP2MYPNErcVGvtcZQ2bXLNUSYvS0s+Q6KOlB+8N1QaumUlzLDn9iiRSNWEuCkJFuTbUhiXMxb9UWiAhsglTs/eYWpaQc1lR7hUN4XDrJtcRylgt5IIlIc5iE+Yz1yxheMXLioDDEKBMFUU/DsUq7ngbrnakw2XcjzafT3goZfyZaNzS1UY55bMw9TGsOrl2yLjWvGGblZuYK44evF/XZnWLJppvYckViO6FB2MJExbL/i47Tk2rT5d0ioo4cSmsT13rjoWXn7wnratyJT9rYchJb5H5R0rJz97ceP3InlGwgVn0BoddOj0Bl5od3aUxEd5xyxf9Pb1zc2PP011lll4lwOSqLjLK9SPXI1ft+PyyFpUKeZHWrlrXvuZrnLWktpyNVwm7upuZK18R8zUc+KrAuYW6qlBDqrRE/aCfark3zB0dH68S1tzNXvM/yd4TOrzl3dz97IpfXWHwz6D14dNVwvK7af22Lc/9icQeP151tm7Dlr+bqax5F9+t1V2A0agQnEGZvZInOkPdE8RMqQK57O9Pvgg945LKfyenr2+H9kH6hhxdGDkEmwsTLBMsRVGAxwknp6+pOivmwfMYwVvXbuBgNKZI5V6+BgLkCcCl4ODMS9K9Zo2PE1Fa1C4gFov10vYo1EWHcJOgTJitFCVdhqjthLiBGDKhMbVF41oaVG2BZ5nwdhiMxcqMWCvIU1XfIffPkSSHRe0SxJaUNJZqXdaqq64K6VssnG+e1ToWlAnU1cC1on6LTk5RKgTUw58ASuOXc5hzY1En1HxBktc1+d4tSryqUAuUKY7YHUrqtbjzNIP6UeFfSePt7NHhIf3bMHFrvSG0eds3UjRfsOTj3dzbjbwfJsf6pqHvbPTz/OhbU8kyzenMSzRm3U5vWXIHA325CVkIie+iUN4dHR6+e0SSWyXseJtw3qgSbU5HsSRNXWolFwlUBXLqadAN8AUXEmh7/TvKCrVW+nauP42y24RwfHj4btwK4dFNIbySLmno2oVO1QXKP5bT/vbWb0+kXpXOO/beLhMeyM2zNWb7455Jg2mthW3Y5OyaXQ15JYZ+fnJ2vjonrbO5ogCwUsZRzG3OJuzgRjzo+rUo2Di7ZrUu2IRFg2a4zCixd8Oo8UocXI7ZKtlcsdUE7oQ2li+EXAxvXXXesfqGjsNLfI3hzmOvxHdILnuQZx8qYYLUIEdORo8kSKf8UxcMfx3PKoapWyPP7lA2Y8kYSq5Fh5tP+JZ4rxfuncVYy4VPbfTEOo5YG+HQzzZmOetUrw0PYnQwdm710fGx8z+fjJ2j9vCp84GOH6/OvYR7/oDLP/RNfjBGfdvlhlYk07lyBxCEclKhfEO2kfT8cnzTAcQiVSW69HKOEMH/869/uxXRmrpr+AWc1BoqtURN7X/UMjUv8EqQNep1J1J863LfvCzQGAp6pcWF7+wTC1e+iaYo5RWfiULQxSUw5cucvbtvRvBzjpQNo6kvta9kXWJB9x0KpS6cxVTAa6vKfvcgLJW+mBNJCXCYUa8WGgMGMS5BmXOZUhLL63MCSgOX3l2ptDAIXJQETMYb53ORCkJMr5TmqYWSS75A2ixxjihJoYqdVlrNyPcxqqi9dad+L0TrWXRJtBG8JG/KMU6DGVouCsy8YTeJd6zCo0VsyAxmaCxUtL1I0XQ16wIvUbv7606S7BRUil5TwQvymvtnS4is5tKQq+sJikfTii94Hm6PjDcjoHwdGQjyukgBCiEvqPFwCGetmv2MMyMsdk74crm88ZY8WF/zjbB5PQONlerWLdyge3n6y9uPB3TzUZfmZP4G9aVIMTxkO/Y8cMAHwcbw1NmYeJ95Jf6+uYDe+0KkKA32LMKzb15/D5fwcHTIkt7r+REEH3z/6sXXP775mvDS++7v33h0ODp0mQNlbMllb6sXvrn3tHvPNvJarbHcdwzvO4b3HcP7juF9x/C+Y3jfMXyfeNp3DO87hvcdw79nx8y+Y3jfMTzddwzDvmN43zG87xjedwzvO4b3HcP7juF9x/C+Y/j/qGM41A7JYzqoCi5c8dlVG65D3fhss4/4PGE5FZYnZ+z6mrLHb3WxWtHwhxo1VaXPE3bJtaAsoKtJJ7H2StXKC2yo5OArCsNT2j/xWufKIxuleCod+xXP3DHdCtuvfb8+eXPKEjYLvc6lymiN5kvqg+ZLNiHvlLmeaSdh1+3KXSNbweWidgVU5vFSyZjXNl+vN1+4enP40avDctn0qFwvRHtW6C8xtnXBX6lG8R02f2vB/czOBUG2EZqO8Hy1Wv0XugLodA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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:"eJztGmtvGzfyr0z5pY2wki3HeZxwOFwevTbow0HjoDhYRkrtjrSMd8kNybW8NfTtfsn9tPslh+FjdyVLdpIWre+gL7aWHA5nhkPO85pZvjBscsZOsawKbtGw84RlaFItKiuUZBN2miPEaXihkdM4PHv9CnhRqKWB2qA2YBWkNImQ1saqUvzKZwWCjYgTWOYizcGgvkTgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEmliKWwOlcYM50JiBsbqOrW1RjOCt5WSYOo0RWPmddHu5MkQSiZgc3SEarS1lgY41FJ8qBEGgwj9TmSDAdicW0i5hBkSOxlxEwjCHjkzTnNKOsSmwlTMBQEHXKOpnMq3VaF4Bo2qocrmICSoWsPZYPASZ/UC3r4aDM6/yq2tzOTggFfVSFUojVjIgs/MKFXlQUaAVTZ/ADlqdJiItEzzJSxFtkBrgMsMUlU1kKqh0iKT3GICFV8gyLqcoQY1JyrLEfDCqBaJW0NsPD4miNcv/+GIHgyeY6F66DWCqatKaYsZ8UAMRzlMBgNa80KVpZJQcc1LtKQCah4RTAhgSGJuKpwMBvBKZiIlNXCYaLSDHnlQIp5A3wS5etA1lmTQIeJmyaWlY6oKnqID1UhHYsUlriO+SqAhxC9RqkhBrrT4VUnLCyfKS9RWpLyAVCmdCeko9RIEY7l2alkpIW0cDTvAP4Nga+OJyMIpE2kZiaUU0s0YhEte1GgCVcsEcqLqJ6w0GqdeAa/NHU05ikW+cz+eva+NXUMMtSEy+1SEvTR+qIXGzIkXndjmvDAIYr4my5JfYG83UO4N4MUInjeQ4ZzXhU1A2C8NWF3jCH5UFnhVFSJ1l53uMakypys6dKccFCIQInnpzvi1VpciQ7qRmZjPUaO0QJMORdTCQB0pY+UWEHul0kQjl6Bk76DHIxgM2r2div7yyy9TeT2VAFNGtEzZZMpakClLwM+Rik3ZZJxAGLiasgk8PHoSARr6fnz0NH4v6Xs8Po7fOX0fjadyFTY9csRYXla3EELTvz8R8dMfnaFBtzONRTWgQTo/D0szJHoabcmiiVXH0ENiSEhhBS/Mbp4ixP1jq6Nsg7Nj4gxLLordbLnp+8dTIGuDoUej7p7t4MejuG/s+F8b3Dwmbt6rGVhhi1tYakHuH1890jaYe0LMpaqsuGx2sxYA7h9jLWEbbD0ltjJubzkumr1/DAWq4kQweH7u8Hg4fjQ8Ojw67kHMlS55ACjLYZYNm6Zppgw6iYDjn2xfQEfmL9o/b6vJx5xrVW5xbpzv0UEFX8D9jg7BD+QGzKKF7Ly1zj31VK7bcKsy3nxpPKq4NBhpD9+5Yk2PTDdFdDTk1aa5EmkgnmCC4GFGzuSIhDAkOWYHP/xw4CWTdIPDsgzi8mdBo/Q9dJLsj5blKMtGm7B9gfdHS8iyBLaMb5/IMijLcte4nyAVn8q/jFzccGVn6mq3ageA+6fdHWFbFTwYhTiXCxkmgnbABoDGRV1wjVfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPjqJLieD4JSEj3rCGjk7nU3yOwj0bjAK4fDx6xEjMhC8GjqNKc41UW55HkqWTQhFDGJ/0p5JSiGKNBaN4o2Ha0TMZXjQ/fO55he3Ko5EeL+qU6PsjjpQw6aPpuykgfDy+bY/VY2Rz1l5+0agwWmFrPeWti2GM57WsYzkjQBu5ClIy8XGRZ8hkU31yMuHGOPVZoohfRERDEcRnxull9tzIbJ1Ral9kz0tSm+flEno9SgECbGousi6K8OMZzLREj0KYgZQlwAs/b13qbkXkq9+I6OcjO8M2jXCeMG4tItIZ6Tabx9QdZ37EBw4ADb8DlutmuDwMLayfTlQjhKIUVZl73URsQaJVYGK9gXF62k3FTcoX+6N3bgV3fsELJDOzaYyrGLQDOtqkwtpbvlsN33CSD375r3KPst13zNrHi433KNIlX9a7TFohCotyXtFTK779AITuj9phSCXyQM8DTFymK28YCPXTSveSYUzGprldz9hPeh7t/5blD3B5wxMfxxp9yn7c866akc+0RH6VORu7IcpTvP+3a6gaztxxBMnGQJU5XLsyv5KmMT5nP2MYPNErcVGvtcZQ2bXLNUSYvS0s+Q6KOlB+8N1QaumUlzLDn9iiRSNWEuCkJFuTbUhiXMxb9UWiAhsglTs/eYWpaQc1lR7hUN4XDrJtcRylgt5IIlIc5iE+Yz1yxheMXLioDDEKBMFUU/DsUq7ngbrnakw2XcjzafT3goZfyZaNzS1UY55bMw9TGsOrl2yLjWvGGblZuYK44evF/XZnWLJppvYckViO6FB2MJExbL/i47Tk2rT5d0ioo4cSmsT13rjoWXn7wnratyJT9rYchJb5H5R0rJz97ceP3InlGwgVn0BoddOj0Bl5od3aUxEd5xyxf9Pb1zc2PP011lll4lwOSqLjLK9SPXI1ft+PyyFpUKeZHWrlrXvuZrnLWktpyNVwm7upuZK18R8zUc+KrAuYW6qlBDqrRE/aCfark3zB0dH68S1tzNXvM/yd4TOrzl3dz97IpfXWHwz6D14dNVwvK7af22Lc/9icQeP151tm7Dlr+bqax5F9+t1V2A0agQnEGZvZInOkPdE8RMqQK57O9Pvgg945LKfyenr2+H9kH6hhxdGDkEmwsTLBMsRVGAxwknp6+pOivmwfMYwVvXbuBgNKZI5V6+BgLkCcCl4ODMS9K9Zo2PE1Fa1C4gFov10vYo1EWHcJOgTJitFCVdhqjthLiBGDKhMbVF41oaVG2BZ5nwdhiMxcqMWCvIU1XfIffPkSSHRe0SxJaUNJZqXdaqq64K6VssnG+e1ToWlAnU1cC1on6LTk5RKgTUw58ASuOXc5hzY1En1HxBktc1+d4tSryqUAuUKY7YHUrqtbjzNIP6UeFfSePt7NHhIf3bMHFrvSG0eds3UjRfsOTj3dzbjbwfJsf6pqHvbPTz/OhbU8kyzenMSzRm3U5vWXIHA325CVkIie+iUN4dHR6+e0SSWyXseJtw3qgSbU5HsSRNXWolFwlUBXLqadAN8AUXEmh7/TvKCrVW+nauP42y24RwfHj4btwK4dFNIbySLmno2oVO1QXKP5bT/vbWb0+kXpXOO/beLhMeyM2zNWb7455Jg2mthW3Y5OyaXQ15JYZ+fnJ2vjonrbO5ogCwUsZRzG3OJuzgRjzo+rUo2Di7ZrUu2IRFg2a4zCixd8Oo8UocXI7ZKtlcsdUE7oQ2li+EXAxvXXXesfqGjsNLfI3hzmOvxHdILnuQZx8qYYLUIEdORo8kSKf8UxcMfx3PKoapWyPP7lA2Y8kYSq5Fh5tP+JZ4rxfuncVYy4VPbfTEOo5YG+HQzzZmOetUrw0PYnQwdm710fGx8z+fjJ2j9vCp84GOH6/OvYR7/oDLP/RNfjBGfdvlhlYk07lyBxCEclKhfEO2kfT8cnzTAcQiVSW69HKOEMH/869/uxXRmrpr+AWc1BoqtURN7X/UMjUv8EqQNep1J1J863LfvCzQGAp6pcWF7+wTC1e+iaYo5RWfiULQxSUw5cucvbtvRvBzjpQNo6kvta9kXWJB9x0KpS6cxVTAa6vKfvcgLJW+mBNJCXCYUa8WGgMGMS5BmXOZUhLL63MCSgOX3l2ptDAIXJQETMYb53ORCkJMr5TmqYWSS75A2ixxjihJoYqdVlrNyPcxqqi9dad+L0TrWXRJtBG8JG/KMU6DGVouCsy8YTeJd6zCo0VsyAxmaCxUtL1I0XQ16wIvUbv7606S7BRUil5TwQvymvtnS4is5tKQq+sJikfTii94Hm6PjDcjoHwdGQjyukgBCiEvqPFwCGetmv2MMyMsdk74crm88ZY8WF/zjbB5PQONlerWLdyge3n6y9uPB3TzUZfmZP4G9aVIMTxkO/Y8cMAHwcbw1NmYeJ95Jf6+uYDe+0KkKA32LMKzb15/D5fwcHTIkt7r+REEH3z/6sXXP775mvDS++7v33h0ODp0mQNlbMllb6sXvrn3tHvPNvJarbHcdwzvO4b3HcP7juF9x/C+Y3jfMXyfeNp3DO87hvcdw79nx8y+Y3jfMTzddwzDvmN43zG87xjedwzvO4b3HcP7juF9x/C+Y/j/qGM41A7JYzqoCi5c8dlVG65D3fhss4/4PGE5FZYnZ+z6mrLHb3WxWtHwhxo1VaXPE3bJtaAsoKtJJ7H2StXKC2yo5OArCsNT2j/xWufKIxuleCod+xXP3DHdCtuvfb8+eXPKEjYLvc6lymiN5kvqg+ZLNiHvlLmeaSdh1+3KXSNbweWidgVU5vFSyZjXNl+vN1+4enP40avDctn0qFwvRHtW6C8xtnXBX6lG8R02f2vB/czOBUG2EZqO8Hy1Wv0XugLodA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(n.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,a.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(l.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink