OpenSign/assets/js/8e4d0438.6ff9af84.js

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3891],{29734(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","source":"@site/docs/help/Settings/APIToken.md","sourceDirName":"help/Settings","slug":"/help/Settings/APIToken","permalink":"/docs/help/Settings/APIToken","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/Settings/APIToken.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"sidebar_position":2,"title":"API Token"},"sidebar":"tutorialSidebar","previous":{"title":"My Signature","permalink":"/docs/help/Settings/my-signature"},"next":{"title":"Webhook","permalink":"/docs/help/Settings/Webhook"}}');var i=t(74848),o=t(28453);const r={sidebar_position:2,title:"API Token"},d="\ud83d\udd10 API Authentication \u2013 Setting Up Your x-api-token",l={},a=[{value:"\ud83e\udded Step-by-Step Guide to Generate Your API Token",id:"-step-by-step-guide-to-generate-your-api-token",level:2},{value:"\ud83e\uddea Sandbox API Token",id:"-sandbox-api-token",level:3},{value:"\ud83e\uddea API Credits",id:"-api-credits",level:3},{value:"Where API Credits Are Deducted",id:"where-api-credits-are-deducted",level:3},{value:"In the OpenSign Application",id:"in-the-opensign-application",level:3},{value:"\ud83e\uddea Sandbox Cloud Account Login",id:"-sandbox-cloud-account-login",level:3},{value:"\ud83d\udd10 How to Access the Sandbox Environment",id:"-how-to-access-the-sandbox-environment",level:4},{value:"Buy the api credit",id:"buy-the-api-credit",level:3},{value:"\ud83e\udde0 Frequently Asked Questions",id:"-frequently-asked-questions",level:2}];function c(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsxs)(n.h1,{id:"-api-authentication--setting-up-your-x-api-token",children:["\ud83d\udd10 API Authentication \u2013 Setting Up Your ",(0,i.jsx)(n.code,{children:"x-api-token"})]})}),"\n",(0,i.jsxs)(n.p,{children:["To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (",(0,i.jsx)(n.code,{children:"x-api-token"}),")."]}),"\n",(0,i.jsx)(n.p,{children:"Follow the steps below to generate one."}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," You can generate both ",(0,i.jsx)(n.strong,{children:"Live"})," and ",(0,i.jsx)(n.strong,{children:"Sandbox"})," API tokens from your OpenSign account."]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"-step-by-step-guide-to-generate-your-api-token",children:"\ud83e\udded Step-by-Step Guide to Generate Your API Token"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Step 1:"})," Log in to your OpenSign account using valid credentials."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Step 2:"})," Navigate to the ",(0,i.jsx)(n.strong,{children:"Settings"})," section and click on ",(0,i.jsx)(n.strong,{children:"API Token"}),"."]}),"\n",(0,i.jsx)("img",{width:"436",alt:"Navigate-to-Api-token",src:"https://github.com/user-attachments/assets/e0e05a23-f815-4805-a047-f08d3727ad98"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Step 3:"})," On the API Token page, click the ",(0,i.jsx)(n.strong,{children:"Generate Live API Token"})," button."]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," To generate a ",(0,i.jsx)(n.strong,{children:"Live API Token"}),", you must upgrade to a ",(0,i.jsx)(n.strong,{children:"paid plan"})," \u2014 either the ",(0,i.jsx)(n.strong,{children:"Professional"})," or ",(0,i.jsx)(n.strong,{children:"Teams"})," plan."]}),"\n"]}),"\n",(0,i.jsx)("img",{width:"436",alt:"Generate token",src:"https://github.com/user-attachments/assets/f5a17744-cfce-464f-9b82-685570ed1e39"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Your ",(0,i.jsx)(n.code,{children:"x-api-token"})," will now be generated and displayed."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Copy this token"})," \u2014 you\u2019ll need it to authenticate your OpenSign API requests."]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"-sandbox-api-token",children:"\ud83e\uddea Sandbox API Token"}),"\n",(0,i.jsxs)(n.p,{children:["You\u2019ll also find the option to generate a ",(0,i.jsx)(n.strong,{children:"Sandbox API Token"})," on the same page."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Sandbox API tokens"})," are available on all plans, including the ",(0,i.jsx)(n.strong,{children:"free plan"}),", and are intended for development and testing."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Do not upload confidential data"})," to the Sandbox environment."]}),"\n",(0,i.jsx)("img",{width:"436",alt:"Sandbox api token",src:"https://github.com/user-attachments/assets/f27d9e00-7989-4c01-b23e-cecaccce4be2"}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"-api-credits",children:"\ud83e\uddea API Credits"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Premium Credits Available:"}),(0,i.jsx)(n.br,{}),"\n","Displays the total API credits available for your organisation."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Your Credits Usage:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Used Credits:"})," The number of credits you have consumed."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Remaining Credits:"})," The number of credits still available for you to use."]}),"\n"]}),"\n",(0,i.jsx)("img",{width:"436",alt:"API credit",src:"https://github.com/user-attachments/assets/e0d87fb2-7391-4bad-b668-9ce2b558c52d"}),"\n",(0,i.jsx)(n.h3,{id:"where-api-credits-are-deducted",children:"Where API Credits Are Deducted"}),"\n",(0,i.jsx)(n.p,{children:"API credits are consumed whenever a document is created through the following actions:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Self Sign API:"})," Credits deducted when a document is created."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Draft Document API:"})," Deducted when drafting a document."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Create Document API:"})," Deducted on document creation."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Draft Template API:"})," Deducted when:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Sending a document if signers are already assigned,"}),"\n",(0,i.jsx)(n.li,{children:"Bulk sending,"}),"\n",(0,i.jsx)(n.li,{children:"Creating documents using public templates (signer fills details and finish)."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Create Document From Template API:"})," Deducted on document creation."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"in-the-opensign-application",children:"In the OpenSign Application"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Manage Templates \u2192 Bulk Send:"})," Credits are deducted for each document created."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Public Template Signing:"})," Credits are deducted when a document is created during public signing (when the signer enters details and completes the process)."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"-sandbox-cloud-account-login",children:"\ud83e\uddea Sandbox Cloud Account Login"}),"\n",(0,i.jsxs)(n.p,{children:["OpenSign provides a ",(0,i.jsx)(n.strong,{children:"sandbox testing cloud environment"}),", which is a replica of the production environment. This allows users to test features without affecting live data."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\u2705 Available in ",(0,i.jsx)(n.strong,{children:"all plans"}),", including the ",(0,i.jsx)(n.strong,{children:"free plan"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["\ud83e\uddea Ideal for ",(0,i.jsx)(n.strong,{children:"testing and development"})," purposes."]}),"\n"]}),"\n",(0,i.jsx)("img",{width:"436",alt:"login to sandbox",src:"https://github.com/user-attachments/assets/3bc6bacd-9c15-4232-b9d7-6d0fb423cf57"}),"\n",(0,i.jsx)(n.h4,{id:"-how-to-access-the-sandbox-environment",children:"\ud83d\udd10 How to Access the Sandbox Environment"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Go to the ",(0,i.jsx)(n.strong,{children:"Settings"})," menu."]}),"\n",(0,i.jsxs)(n.li,{children:["Click on ",(0,i.jsx)(n.strong,{children:"API Token"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["On the API Token page, click ",(0,i.jsx)(n.strong,{children:"Login to Sandbox"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["You will be automatically logged in to the sandbox environment using your existing account \u2014 ",(0,i.jsx)(n.strong,{children:"no need to enter your username or password"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,i.jsx)(n.strong,{children:"Important Note:"}),(0,i.jsx)(n.br,{}),"\n","Manually entering your username and password will ",(0,i.jsx)(n.strong,{children:"not work"}),' for sandbox login. Always use the "Login to Sandbox" button for access.']}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"buy-the-api-credit",children:"Buy the api credit"}),"\n",(0,i.jsx)(n.p,{children:"User can buy the api credit using this feature\nOn the click of the buy premium credits the"}),"\n",(0,i.jsx)(n.h2,{id:"-frequently-asked-questions",children:"\ud83e\udde0 Frequently Asked Questions"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"1. What is the OpenSign Sandbox environment?"}),(0,i.jsx)(n.br,{}),"\n","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."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"2. Can I upload large documents to the Sandbox?"}),(0,i.jsx)(n.br,{}),"\n","No. Please avoid uploading documents larger than ",(0,i.jsx)(n.strong,{children:"5MB"})," in the Sandbox. It is optimized for lightweight testing only."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"3. Can I use my Live API Token in the Sandbox?"}),(0,i.jsx)(n.br,{}),"\n","No. ",(0,i.jsx)(n.strong,{children:"Live API Tokens do not work"})," in the Sandbox environment. You\u2019ll need to generate a separate token specifically for Sandbox testing."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"4. Why can\u2019t I use a live template in the Sandbox?"}),(0,i.jsx)(n.br,{}),"\n","Live and Sandbox environments are ",(0,i.jsx)(n.strong,{children:"separate"}),". Templates created in the Live environment cannot be used in the Sandbox, and vice versa."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"5. Can I use the API in the free self-hosted environment?"}),(0,i.jsx)(n.br,{}),"\n","No. The ",(0,i.jsx)(n.strong,{children:"free self-hosted version"})," does not support API token generation.",(0,i.jsx)(n.br,{}),"\n","To use OpenSign APIs in a self-hosted setup, you must upgrade to a ",(0,i.jsx)(n.strong,{children:"paid self-hosted plan"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at ",(0,i.jsx)(n.a,{href:"mailto:support@opensignlabs.com",children:"support@opensignlabs.com"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453(e,n,t){t.d(n,{R:()=>r,x:()=>d});var s=t(96540);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);