From eb1086e5b16cf4034cd7c9cabcb1b3394c07400f Mon Sep 17 00:00:00 2001 From: pravin Date: Fri, 16 May 2025 12:26:42 +0530 Subject: [PATCH] Create APIToken.md added new file how to genarate api token --- docs/docs/help/Settings/APIToken.md | 57 +++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 docs/docs/help/Settings/APIToken.md diff --git a/docs/docs/help/Settings/APIToken.md b/docs/docs/help/Settings/APIToken.md new file mode 100644 index 000000000..b2e0b655c --- /dev/null +++ b/docs/docs/help/Settings/APIToken.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 3 +title: API Token +--- + +# 🔐 API Authentication – Setting up Your `x-api-token` + +To authenticate and use OpenSign API endpoints, you’ll need a valid API token (`x-api-token`). + +Follow the steps below to generate one. + +**Note:** You can generate both **Live** and **Sandbox** API tokens from your OpenSign account. + +--- + +## 🧭 Step-by-Step Guide to Generate Your API Token + +**Step 1:** Log in to your OpenSign account using valid credentials. + +**Step 2:** Navigate to the **Settings** section and click on **API Token**. + +**Step 3:** On the API Token page, click the **Generate Live API Token** button. + +Navigate-to-Api-token + +Generate token + + +- Your `x-api-token` will now be generated and displayed. +- **Copy this token** — you’ll use it to authenticate OpenSign API requests. + +**Optional:** +On the same page, you’ll also find the option to generate a **Sandbox API Token** for development and testing purposes. + +--- + +## 🧠 Frequently Asked Questions + +**1. What is the OpenSign Sandbox environment?** +The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with testing limitations. + + +**2. Can I upload large documents to the Sandbox?** +No. Please avoid uploading documents larger than **5MB** in the Sandbox. It is optimized for lightweight testing only. + + +**3. Can I use my live API token in the Sandbox?** +No. **Live API tokens do not work** in the Sandbox environment. You’ll need to generate a separate token specific to Sandbox testing. + + +**4. Why can’t I use a live template in the Sandbox?** +Live and Sandbox environments are **separate**. Templates created in the live environment cannot be used in the Sandbox, and vice versa. + + +**5. Can I use the API in the free self-hosted environment?** +No. We do not support generating API tokens in the **free self-hosted version**. +If you want to use OpenSign APIs in a self-hosted setup, you must upgrade to the **paid self-hosted plan**.