mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-20 14:42:37 +02:00
112 lines
30 KiB
HTML
112 lines
30 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-help/Settings/APIToken" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">API Token | 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/help/Settings/APIToken"><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="API Token | OpenSign™"><meta data-rh="true" name="description" content="To authenticate and use OpenSign API endpoints, you’ll need a valid API token (x-api-token)."><meta data-rh="true" property="og:description" content="To authenticate and use OpenSign API endpoints, you’ll need a valid API token (x-api-token)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/help/Settings/APIToken"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/help/Settings/APIToken" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/help/Settings/APIToken" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Settings","item":"https://docs.opensignlabs.com/docs/category/settings"},{"@type":"ListItem","position":2,"name":"API Token","item":"https://docs.opensignlabs.com/docs/help/Settings/APIToken"}]}</script><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.03fa8acf.css">
|
||
<script src="/assets/js/runtime~main.9e610c3a.js" defer="defer"></script>
|
||
<script src="/assets/js/main.62d29b20.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><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"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const a=new URLSearchParams(window.location.search).entries();for(var[t,e]of a)if(t.startsWith("docusaurus-data-")){var n=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(n,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_mb4j" style="background-color:#cae4fa;color:#091E42" role="banner"><div class="content_knG7 announcementBarContent_xLdY">Help use spread the word - ⭐ OpenSign on <a target="_blank" rel="noopener" href="https://github.com/opensignlabs/opensign">GitHub</a></div></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">OpenSign™</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/help/intro">Help</a><a class="navbar__item navbar__link" href="/docs/API-docs/v1.1">APIs</a><a class="navbar__item navbar__link" href="/docs/contribute/CODE_OF_CONDUCT">Contribute</a><a href="https://www.opensignlabs.com/plans-pricing" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Cloud Pricing<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a class="navbar__item navbar__link" href="/docs/self-host/intro">Self-host</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/help/intro"><span title="Intro" class="linkLabel_WmDU">Intro</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/category/create-new-opensign-document"><span title="Create New OpenSign Document" class="categoryLinkLabel_W154">Create New OpenSign Document</span></a><button aria-label="Expand sidebar category 'Create New OpenSign Document'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/category/manage-docs-using-opensign-drive"><span title="Manage Docs using OpenSign™ Drive" class="categoryLinkLabel_W154">Manage Docs using OpenSign™ Drive</span></a><button aria-label="Expand sidebar category 'Manage Docs using OpenSign™ Drive'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/category/documents"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a><button aria-label="Expand sidebar category 'Documents'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/category/templates"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a><button aria-label="Expand sidebar category 'Templates'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--active" href="/docs/category/settings"><span title="Settings" class="categoryLinkLabel_W154">Settings</span></a><button aria-label="Collapse sidebar category 'Settings'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/my-signature"><span title="My Signature" class="linkLabel_WmDU">My Signature</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/help/Settings/APIToken"><span title="API Token" class="linkLabel_WmDU">API Token</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/Webhook"><span title="Webhook" class="linkLabel_WmDU">Webhook</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/Preferences"><span title="Preferences" class="linkLabel_WmDU">Preferences</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/Teams"><span title="Manage Teams" class="linkLabel_WmDU">Manage Teams</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/manage-users"><span title="Manage users" class="linkLabel_WmDU">Manage users</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/disabledocumentid"><span title="Disable DocumentId" class="linkLabel_WmDU">Disable DocumentId</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/Custom-email-templates"><span title="Custom email templates" class="linkLabel_WmDU">Custom email templates</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/help/Settings/SecurityManagement"><span title="Security" class="linkLabel_WmDU">Security</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/category/user-menu"><span title="User Menu" class="categoryLinkLabel_W154">User Menu</span></a><button aria-label="Expand sidebar category 'User Menu'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/category/faqs"><span title="FAQs" class="categoryLinkLabel_W154">FAQs</span></a><button aria-label="Expand sidebar category 'FAQs'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_xLCN"><div class="docItemContainer_jfFK"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/docs/category/settings"><span>Settings</span></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">API Token</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><div class="row"><div class="col col--12 markdown"><header><h1>🔐 API Authentication – Setting Up Your <code>x-api-token</code></h1></header>
|
||
<p>To authenticate and use OpenSign API endpoints, you’ll need a valid API token (<code>x-api-token</code>).</p>
|
||
<p>Follow the steps below to generate one.</p>
|
||
<blockquote>
|
||
<p><strong>Note:</strong> You can generate both <strong>Live</strong> and <strong>Sandbox</strong> API tokens from your OpenSign account.</p>
|
||
</blockquote>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="-step-by-step-guide-to-generate-your-api-token">🧭 Step-by-Step Guide to Generate Your API Token<a href="#-step-by-step-guide-to-generate-your-api-token" class="hash-link" aria-label="Direct link to 🧭 Step-by-Step Guide to Generate Your API Token" title="Direct link to 🧭 Step-by-Step Guide to Generate Your API Token" translate="no"></a></h2>
|
||
<p><strong>Step 1:</strong> Log in to your OpenSign account using valid credentials.</p>
|
||
<p><strong>Step 2:</strong> Navigate to the <strong>Settings</strong> section and click on <strong>API Token</strong>.</p>
|
||
<img width="436" alt="Navigate-to-Api-token" src="https://github.com/user-attachments/assets/e0e05a23-f815-4805-a047-f08d3727ad98">
|
||
<p><strong>Step 3:</strong> On the API Token page, click the <strong>Generate Live API Token</strong> button.</p>
|
||
<blockquote>
|
||
<p><strong>Note:</strong> To generate a <strong>Live API Token</strong>, you must upgrade to a <strong>paid plan</strong> — either the <strong>Professional</strong> or <strong>Teams</strong> plan.</p>
|
||
</blockquote>
|
||
<img width="436" alt="Generate token" src="https://github.com/user-attachments/assets/f5a17744-cfce-464f-9b82-685570ed1e39">
|
||
<ul>
|
||
<li class="">Your <code>x-api-token</code> will now be generated and displayed.</li>
|
||
<li class=""><strong>Copy this token</strong> — you’ll need it to authenticate your OpenSign API requests.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="-sandbox-api-token">🧪 Sandbox API Token<a href="#-sandbox-api-token" class="hash-link" aria-label="Direct link to 🧪 Sandbox API Token" title="Direct link to 🧪 Sandbox API Token" translate="no"></a></h3>
|
||
<p>You’ll also find the option to generate a <strong>Sandbox API Token</strong> on the same page.</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><strong>Sandbox API tokens</strong> are available on all plans, including the <strong>free plan</strong>, and are intended for development and testing.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Do not upload confidential data</strong> to the Sandbox environment.</p>
|
||
<img width="436" alt="Sandbox api token" src="https://github.com/user-attachments/assets/f27d9e00-7989-4c01-b23e-cecaccce4be2">
|
||
</li>
|
||
</ul>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="-api-credits">🧪 API Credits<a href="#-api-credits" class="hash-link" aria-label="Direct link to 🧪 API Credits" title="Direct link to 🧪 API Credits" translate="no"></a></h3>
|
||
<p><strong>Premium Credits Available:</strong><br>
|
||
<!-- -->Displays the total API credits available for your organisation.</p>
|
||
<p><strong>Your Credits Usage:</strong></p>
|
||
<ul>
|
||
<li class=""><strong>Used Credits:</strong> The number of credits you have consumed.</li>
|
||
<li class=""><strong>Remaining Credits:</strong> The number of credits still available for you to use.</li>
|
||
</ul>
|
||
<img width="436" alt="API credit" src="https://github.com/user-attachments/assets/e0d87fb2-7391-4bad-b668-9ce2b558c52d">
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="where-api-credits-are-deducted">Where API Credits Are Deducted<a href="#where-api-credits-are-deducted" class="hash-link" aria-label="Direct link to Where API Credits Are Deducted" title="Direct link to Where API Credits Are Deducted" translate="no"></a></h3>
|
||
<p>API credits are consumed whenever a document is created through the following actions:</p>
|
||
<ul>
|
||
<li class=""><strong>Self Sign API:</strong> Credits deducted when a document is created.</li>
|
||
<li class=""><strong>Draft Document API:</strong> Deducted when drafting a document.</li>
|
||
<li class=""><strong>Create Document API:</strong> Deducted on document creation.</li>
|
||
<li class=""><strong>Draft Template API:</strong> Deducted when:<!-- -->
|
||
<ul>
|
||
<li class="">Sending a document if signers are already assigned,</li>
|
||
<li class="">Bulk sending,</li>
|
||
<li class="">Creating documents using public templates (signer fills details and finish).</li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong>Create Document From Template API:</strong> Deducted on document creation.</li>
|
||
</ul>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="in-the-opensign-application">In the OpenSign Application<a href="#in-the-opensign-application" class="hash-link" aria-label="Direct link to In the OpenSign Application" title="Direct link to In the OpenSign Application" translate="no"></a></h3>
|
||
<ul>
|
||
<li class=""><strong>Manage Templates → Bulk Send:</strong> Credits are deducted for each document created.</li>
|
||
<li class=""><strong>Public Template Signing:</strong> Credits are deducted when a document is created during public signing (when the signer enters details and completes the process).</li>
|
||
</ul>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="-sandbox-cloud-account-login">🧪 Sandbox Cloud Account Login<a href="#-sandbox-cloud-account-login" class="hash-link" aria-label="Direct link to 🧪 Sandbox Cloud Account Login" title="Direct link to 🧪 Sandbox Cloud Account Login" translate="no"></a></h3>
|
||
<p>OpenSign provides a <strong>sandbox testing cloud environment</strong>, which is a replica of the production environment. This allows users to test features without affecting live data.</p>
|
||
<ul>
|
||
<li class="">✅ Available in <strong>all plans</strong>, including the <strong>free plan</strong>.</li>
|
||
<li class="">🧪 Ideal for <strong>testing and development</strong> purposes.</li>
|
||
</ul>
|
||
<img width="436" alt="login to sandbox" src="https://github.com/user-attachments/assets/3bc6bacd-9c15-4232-b9d7-6d0fb423cf57">
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="-how-to-access-the-sandbox-environment">🔐 How to Access the Sandbox Environment<a href="#-how-to-access-the-sandbox-environment" class="hash-link" aria-label="Direct link to 🔐 How to Access the Sandbox Environment" title="Direct link to 🔐 How to Access the Sandbox Environment" translate="no"></a></h4>
|
||
<ol>
|
||
<li class="">Go to the <strong>Settings</strong> menu.</li>
|
||
<li class="">Click on <strong>API Token</strong>.</li>
|
||
<li class="">On the API Token page, click <strong>Login to Sandbox</strong>.</li>
|
||
<li class="">You will be automatically logged in to the sandbox environment using your existing account — <strong>no need to enter your username or password</strong>.</li>
|
||
</ol>
|
||
<blockquote>
|
||
<p>⚠️ <strong>Important Note:</strong><br>
|
||
<!-- -->Manually entering your username and password will <strong>not work</strong> for sandbox login. Always use the "Login to Sandbox" button for access.</p>
|
||
</blockquote>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="buy-the-api-credit">Buy the api credit<a href="#buy-the-api-credit" class="hash-link" aria-label="Direct link to Buy the api credit" title="Direct link to Buy the api credit" translate="no"></a></h3>
|
||
<p>User can buy the api credit using this feature
|
||
On the click of the buy premium credits the</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="-frequently-asked-questions">🧠 Frequently Asked Questions<a href="#-frequently-asked-questions" class="hash-link" aria-label="Direct link to 🧠 Frequently Asked Questions" title="Direct link to 🧠 Frequently Asked Questions" translate="no"></a></h2>
|
||
<p><strong>1. What is the OpenSign Sandbox environment?</strong><br>
|
||
<!-- -->The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with certain limitations.</p>
|
||
<p><strong>2. Can I upload large documents to the Sandbox?</strong><br>
|
||
<!-- -->No. Please avoid uploading documents larger than <strong>5MB</strong> in the Sandbox. It is optimized for lightweight testing only.</p>
|
||
<p><strong>3. Can I use my Live API Token in the Sandbox?</strong><br>
|
||
<!-- -->No. <strong>Live API Tokens do not work</strong> in the Sandbox environment. You’ll need to generate a separate token specifically for Sandbox testing.</p>
|
||
<p><strong>4. Why can’t I use a live template in the Sandbox?</strong><br>
|
||
<!-- -->Live and Sandbox environments are <strong>separate</strong>. Templates created in the Live environment cannot be used in the Sandbox, and vice versa.</p>
|
||
<p><strong>5. Can I use the API in the free self-hosted environment?</strong><br>
|
||
<!-- -->No. The <strong>free self-hosted version</strong> does not support API token generation.<br>
|
||
<!-- -->To use OpenSign APIs in a self-hosted setup, you must upgrade to a <strong>paid self-hosted plan</strong>.</p>
|
||
<p>If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at <a href="mailto:support@opensignlabs.com" target="_blank" rel="noopener noreferrer" class="">support@opensignlabs.com</a>.</p></div></div></div><div class="row"><div class="col col--12"><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/Settings/APIToken.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></div></div></article><div class="row"><div class="col col--12"><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/help/Settings/my-signature"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">My Signature</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/help/Settings/Webhook"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Webhook</div></a></nav></div></div></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#-step-by-step-guide-to-generate-your-api-token" class="table-of-contents__link toc-highlight">🧭 Step-by-Step Guide to Generate Your API Token</a><ul><li><a href="#-sandbox-api-token" class="table-of-contents__link toc-highlight">🧪 Sandbox API Token</a></li><li><a href="#-api-credits" class="table-of-contents__link toc-highlight">🧪 API Credits</a></li><li><a href="#where-api-credits-are-deducted" class="table-of-contents__link toc-highlight">Where API Credits Are Deducted</a></li><li><a href="#in-the-opensign-application" class="table-of-contents__link toc-highlight">In the OpenSign Application</a></li><li><a href="#-sandbox-cloud-account-login" class="table-of-contents__link toc-highlight">🧪 Sandbox Cloud Account Login</a></li><li><a href="#buy-the-api-credit" class="table-of-contents__link toc-highlight">Buy the api credit</a></li></ul></li><li><a href="#-frequently-asked-questions" class="table-of-contents__link toc-highlight">🧠 Frequently Asked Questions</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |