Skip to content

Commit 344ccad

Browse files
Merge pull request #1739 from pravinOpenSign/patch-30
Create APIToken.md
2 parents ae568a8 + eb1086e commit 344ccad

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
sidebar_position: 3
3+
title: API Token
4+
---
5+
6+
# 🔐 API Authentication – Setting up Your `x-api-token`
7+
8+
To authenticate and use OpenSign API endpoints, you’ll need a valid API token (`x-api-token`).
9+
10+
Follow the steps below to generate one.
11+
12+
**Note:** You can generate both **Live** and **Sandbox** API tokens from your OpenSign account.
13+
14+
---
15+
16+
## 🧭 Step-by-Step Guide to Generate Your API Token
17+
18+
**Step 1:** Log in to your OpenSign account using valid credentials.
19+
20+
**Step 2:** Navigate to the **Settings** section and click on **API Token**.
21+
22+
**Step 3:** On the API Token page, click the **Generate Live API Token** button.
23+
24+
<img width="436" alt="Navigate-to-Api-token" src="https://github.com/user-attachments/assets/8079ecb5-ad5b-4ce6-8d6c-14395130a654"></img>
25+
26+
<img width="436" alt="Generate token" src="https://github.com/user-attachments/assets/6188ae46-0f40-4de6-9903-33ae0aa4e63f"></img>
27+
28+
29+
- Your `x-api-token` will now be generated and displayed.
30+
- **Copy this token** — you’ll use it to authenticate OpenSign API requests.
31+
32+
**Optional:**
33+
On the same page, you’ll also find the option to generate a **Sandbox API Token** for development and testing purposes.
34+
35+
---
36+
37+
## 🧠 Frequently Asked Questions
38+
39+
**1. What is the OpenSign Sandbox environment?**
40+
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.
41+
42+
43+
**2. Can I upload large documents to the Sandbox?**
44+
No. Please avoid uploading documents larger than **5MB** in the Sandbox. It is optimized for lightweight testing only.
45+
46+
47+
**3. Can I use my live API token in the Sandbox?**
48+
No. **Live API tokens do not work** in the Sandbox environment. You’ll need to generate a separate token specific to Sandbox testing.
49+
50+
51+
**4. Why can’t I use a live template in the Sandbox?**
52+
Live and Sandbox environments are **separate**. Templates created in the live environment cannot be used in the Sandbox, and vice versa.
53+
54+
55+
**5. Can I use the API in the free self-hosted environment?**
56+
No. We do not support generating API tokens in the **free self-hosted version**.
57+
If you want to use OpenSign APIs in a self-hosted setup, you must upgrade to the **paid self-hosted plan**.

0 commit comments

Comments
 (0)