WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-20 22:52:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

deploy: e0249211d2

Browse Source
This commit is contained in:
github-actions[bot]
2024-12-19 13:43:31 +00:00
parent 73bbec0ef4
commit 01638aa4e7
103 changed files with 127 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API-docs/drafttemplate/index.html
+9 -4
View File
@@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.0.1">
<title data-rh="true">Draft Template | OpenSign™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" property="og:url" content="https://docs.opensignlabs.com/docs/API-docs/drafttemplate"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Draft Template | OpenSign™"><meta data-rh="true" name="description" content="The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution."><meta data-rh="true" property="og:description" content="The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/API-docs/drafttemplate"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/drafttemplate" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/drafttemplate" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenSign™ RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenSign™ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.f10211b2.css">
<script src="/assets/js/runtime~main.235362e9.js" defer="defer"></script>
<script src="/assets/js/runtime~main.f0e932ef.js" defer="defer"></script>
<script src="/assets/js/main.6ed58c0f.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -13,6 +13,8 @@
<pre class="openapi__method-endpoint"><span class="badge badge--success">POST</span> <h2 class="openapi__method-endpoint-path">/drafttemplate</h2></pre><div class="openapi__divider"></div>
<p>The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique <strong>objectId</strong> (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a <strong>url</strong> is provided, which offers a user interface for editing the template and facilitating document distribution.</p>
<p>Tip: Upload your PDF document to our <a href="https://app.opensignlabs.com/debugpdf" target="_blank" rel="noopener noreferrer"><strong>Debug UI</strong></a>, where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document&#x27;s base64 string, making it quick to send to the API.</p>
<p><strong>When document is created this webhook event will trigger</strong></p>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;event&quot;: &quot;created&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;:&quot;DOCUMENT_ID&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;url&quot;: &quot;SIGNING_URL&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p><strong>Supported Widgets:</strong></p>
<p>Below are the common parameters that are required with all widgets:</p>
<ul>
@@ -77,11 +79,12 @@
<ol start="9">
<li><strong>textbox:</strong></li>
</ol>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;:&quot;textbox&quot;, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;page&quot;:1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;x&quot;: 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;y&quot;: 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;w&quot;: 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;h&quot;: 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;options&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;required&quot;: true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;textbox&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;provide name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;regularexpression&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;color&quot;: &quot;black&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;fontsize&quot;: 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;:&quot;textbox&quot;, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;page&quot;:1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;x&quot;: 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;y&quot;: 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;w&quot;: 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;h&quot;: 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;options&quot;: { </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;textbox&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;required&quot;: true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;provide name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;regularexpression&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;color&quot;: &quot;black&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;fontsize&quot;: 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<ul>
<li><strong>default:</strong> Provide a default value for the textbox (Optional).</li>
<li><strong>hint:</strong> Provide a hint for the textbox (Optional).</li>
<li><strong>regularexpression:</strong> Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).</li>
<li><strong>readonly:</strong> Set to true if you want to set the textbox as readonly. By default, it&#x27;s false.</li>
</ul>
<ol start="10">
<li><strong>checkbox:</strong></li>
@@ -90,7 +93,7 @@
<ul>
<li><strong>values:</strong> Provide options for the checkbox list.</li>
<li><strong>selectedvalues:</strong> Provide values that need to be selected by default (Optional).</li>
<li><strong>readonly:</strong> Set to true if you want to set the checkbox as readonly. By default, it&#x27;s false</li>
<li><strong>readonly:</strong> Set to true if you want to set the checkbox as readonly. By default, it&#x27;s false.</li>
<li><strong>hidelabel:</strong> Set to true if you want to hide labels of the checkbox. By default, it&#x27;s false.</li>
<li><strong>minselections:</strong> Provide the minimum number of checkboxes that must be selected by the user.</li>
<li><strong>maxselections:</strong> Provide the maximum number of checkboxes that can be selected by the user.</li>
@@ -98,10 +101,11 @@
<ol start="11">
<li><strong>dropdown:</strong></li>
</ol>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;:&quot;dropdown&quot;, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;page&quot;:1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;x&quot;: 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;y&quot;: 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;w&quot;: 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;h&quot;: 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;options&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;required&quot;: true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;dropdown&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;values&quot;: [&quot;male&quot;, &quot;female&quot;, &quot;other&quot;],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;color&quot;: &quot;black&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;fontsize&quot;: 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;:&quot;dropdown&quot;, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;page&quot;:1, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;x&quot;: 327, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;y&quot;: 628, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;w&quot;: 114, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;h&quot;: 21, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;options&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;required&quot;: true, </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;dropdown&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;values&quot;: [&quot;male&quot;, &quot;female&quot;, &quot;other&quot;],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;color&quot;: &quot;black&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;fontsize&quot;: 12</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<ul>
<li><strong>values:</strong> Provide options for the dropdown list.</li>
<li><strong>default:</strong> Provide the value that needs to be selected by default. Only one value is accepted. (Optional).</li>
<li><strong>readonly:</strong> Set to true if you want to set the dropdown as readonly. By default, it&#x27;s false.</li>
</ul>
<ol start="12">
<li><strong>radio button:</strong></li>
@@ -110,6 +114,7 @@
<ul>
<li><strong>values:</strong> Provide options for the radio button list.</li>
<li><strong>default:</strong> Provide the value that needs to be selected by default. Only one value is accepted. (Optional).</li>
<li><strong>readonly:</strong> Set to true if you want to set the radio button as readonly. By default, it&#x27;s false.</li>
</ul>
<ol start="13">
<li><strong>image:</strong></li>