mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-10 11:47:39 +02:00
deploy: 8fe31ee59b
This commit is contained in:
github-actions[bot]
@@ -5,7 +5,7 @@
|
||||
<meta name="generator" content="Docusaurus v3.7.0">
|
||||
<title data-rh="true">OpenSign API v1.1 | 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/v1.1/opensign-api-v-1-1"><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="OpenSign API v1.1 | OpenSign™"><meta data-rh="true" name="description" content="Welcome to the OpenSign™ API documentation v1.1!"><meta data-rh="true" property="og:description" content="Welcome to the OpenSign™ API documentation v1.1!"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/opensign-api-v-1-1"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/opensign-api-v-1-1" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/opensign-api-v-1-1" 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.6bed5790.css">
|
||||
<script src="/assets/js/runtime~main.e02902d6.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.10a1f6ec.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.431a68de.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
@@ -20,14 +20,14 @@
|
||||
<li><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer">OpenSign GitHub Repository</a></li>
|
||||
<li><a href="https://docs.opensignlabs.com/docs/help/Settings/APIToken" target="_blank" rel="noopener noreferrer">Generate x-api-token</a> – Learn how to securely generate and manage your API token for authenticating requests.</li>
|
||||
</ul>
|
||||
<p><strong>Update in v1.1:</strong></p>
|
||||
<p><strong>What’s New in v1.1</strong></p>
|
||||
<ul>
|
||||
<li>Public template: A public template can be created and shared via a link. Any user with the link can create and sign a document from it. However, users cannot edit the template itself.</li>
|
||||
<li>Prefill widget: Prefill widgets are embedded in a document before it is sent to users. They are available in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates.</li>
|
||||
<li><strong>Public Templates</strong>: Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link.</li>
|
||||
<li><strong>Prefill Widgets</strong>: Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates.</li>
|
||||
</ul>
|
||||
<div style="margin-bottom:2rem"><h2 class="anchor anchorWithStickyNavbar_LWe7 openapi-tabs__heading" id="authentication">Authentication<a href="#authentication" class="hash-link" aria-label="Direct link to Authentication" title="Direct link to Authentication"></a></h2><div class="openapi-tabs__schema-container"><div class="openapi-tabs__schema-tabs-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__schema-list-container tabs openapi-tabs__security-schemes"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__schema-item active"><span class="openapi-tabs__schema-label">API Key: x-api-token</span></li></ul></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div><table><tbody><tr><th><p>Security Scheme Type:</p></th><td><p>apiKey</p></td></tr><tr><th><p>Header parameter name:</p></th><td><p>x-api-token</p></td></tr></tbody></table></div></div></div></div></div>
|
||||
<div style="display:flex;flex-direction:column;margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>Contact</p></h3><span><p><a href="mailto:api@opensignlabs.com" target="_blank" rel="noopener noreferrer">api@opensignlabs.com</a></p></span></div>
|
||||
<div style="margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>Terms of Service</p></h3><a href="http://www.opensignlabs.com/terms/">http://www.opensignlabs.com/terms/</a></div>
|
||||
<div style="margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>License</p></h3><a href="http://github.com/opensignlabs/opensign/LICENSE"><p>AGPL v 3.0</p></a></div></div></div></div><div class="row"><div class="col col--12"></div></div></article><div class="row"><div class="col col--12"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/API-docs/v1.1"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">v1.1</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/API-docs/v1.1/get-user"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Get your account details</div></a></nav></div></div></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/help/intro">Help</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/API-docs/v1.1">APIs</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contribute/intro">Contribute</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/self-host/intro">Self-host</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.com/invite/xe9TDuyAyj" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/opensign%E2%84%A2/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.twitter.com/opensignhq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.facebook.com/profile.php?id=61551030403669" target="_blank" rel="noopener noreferrer" class="footer__link-item">Facebook<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
|
||||
<div style="margin-bottom:var(--ifm-paragraph-margin-bottom)"><h3 style="margin-bottom:0.25rem"><p>License</p></h3><a href="http://github.com/opensignlabs/opensign/LICENSE"><p>AGPL v3.0</p></a></div></div></div></div><div class="row"><div class="col col--12"></div></div></article><div class="row"><div class="col col--12"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/API-docs/v1.1"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">v1.1</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/API-docs/v1.1/get-user"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Get your account details</div></a></nav></div></div></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/help/intro">Help</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/API-docs/v1.1">APIs</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contribute/intro">Contribute</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/self-host/intro">Self-host</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.com/invite/xe9TDuyAyj" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/opensign%E2%84%A2/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.twitter.com/opensignhq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.facebook.com/profile.php?id=61551030403669" target="_blank" rel="noopener noreferrer" class="footer__link-item">Facebook<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user