WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-23 08:02:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1743 from pravinOpenSign/patch-31

Browse Source 
Patch 31
This commit is contained in:
Raktima
2025-05-19 12:00:58 +05:30
committed by GitHub
parent 4609bba4c1 de9c58e5fd
commit 8b08995e7d
5 changed files with 471 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/help/Settings/APIToken.md
+25 -20
View File
@@ -1,57 +1,62 @@
---
sidebar_position: 4
sidebar_position: 2
title: API Token
---
# 🔐 API Authentication – Setting up Your `x-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.
> **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 1:** Log in to your OpenSign account using valid credentials.
**Step 2:** Navigate to the **Settings** section and click on **API Token**.
**Step 2:** Navigate to the **Settings** section and click on **API Token**.
<img width="436" alt="Navigate-to-Api-token" src="https://github.com/user-attachments/assets/8079ecb5-ad5b-4ce6-8d6c-14395130a654"></img>
<img width="436" alt="Navigate-to-Api-token" src="https://github.com/user-attachments/assets/8079ecb5-ad5b-4ce6-8d6c-14395130a654" />
**Step 3:** On the API Token page, click the **Generate Live API Token** button.
<img width="436" alt="Generate token" src="https://github.com/user-attachments/assets/6188ae46-0f40-4de6-9903-33ae0aa4e63f"></img>
> **Note:** To generate a **Live API Token**, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
<img width="436" alt="Generate token" src="https://github.com/user-attachments/assets/6188ae46-0f40-4de6-9903-33ae0aa4e63f" />
- Your `x-api-token` will now be generated and displayed.
- **Copy this token** — you’ll use it to authenticate OpenSign API requests.
- **Copy this token** — you’ll need it to authenticate your 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.
---
### 🧪 Sandbox API Token
You’ll also find the option to generate a **Sandbox API Token** on the same page.
- **Sandbox API tokens** are available on all plans, including the **free plan**, and are intended for development and testing.
- **Do not upload confidential data** to the Sandbox environment.
---
## 🧠 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.
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.
**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.
**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 specifically for 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.
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**.
No. The **free self-hosted version** does not support API token generation.
To use OpenSign APIs in a self-hosted setup, you must upgrade to a **paid self-hosted plan**.
If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com.
docs/docs/help/Settings/Teams.md
+102
View File
@@ -0,0 +1,102 @@
---
sidebar_position: 5
title: Manage Teams
---
# 👥 Teams Management in OpenSign
The **Teams** feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.
---
## 🧭 How to Access the Teams Page
1. Log in to your OpenSign account.
2. In the left-hand sidebar, navigate to **Settings → Teams**.
<img width="436" alt="Navigate-to-Teams" src="https://github.com/user-attachments/assets/2e292fc2-83b9-41b4-b133-451286744547"></img>
---
## 📋 Teams Overview
On the Teams page, you'll see a list of all existing teams. Each row includes:
| Column | Description |
|----------------|------------------------------------------------------------------------------|
| **Sr. No** | Serial number of the team in the list. |
| **Name** | The name of the team. |
| **Parent Team**| The parent team this team belongs to (useful for hierarchical grouping). |
| **Active** | Toggle to activate or deactivate the team. |
| **Edit** | Click the pencil icon to edit the team name or parent team. |
- 🟢 **Active** teams are currently usable across OpenSign modules.
- ⚪ **Inactive** teams are hidden from functional views but not deleted.
---
## ➕ Adding a New Team
To create a new team:
1. Click the **➕ Add Team** button at the top-right of the page.
2. A modal will appear titled **Add Team**.
**Fill in the following details:**
- **Name** (Required): Enter a name for the new team.
- **Parent Team**: Choose a parent group (default is **All Users**).
<img width="436" alt="add team" src="https://github.com/user-attachments/assets/74c042b1-2c31-4d00-81f4-0abeaf0c985c"></img>
3. Click **Submit** to create the team or **Reset** to clear the form.
> 📝 **Tip:** Use parent teams to build a team hierarchy — for example, placing _Marketing_ under _HR_.
<img width="436" alt="New team" src="https://github.com/user-attachments/assets/7f69afeb-c96e-46d4-b5ee-5af9dd656d2a"></img>
---
## 🖊️ Editing an Existing Team
To edit a team:
1. Click the **pencil icon** next to the team name.
2. Modify the team name or parent group.
3. Save the changes.
---
## 🌐 Where You Can Use the Teams
1. **Active teams** are available when creating new users — you can select a team from the dropdown and add multiple users under one team.
<img width="436" alt="create new user" src="https://github.com/user-attachments/assets/3aea0ff3-5aa2-416c-b6cc-7148e7d694e6"></img>
2. You can also **share templates** with teams. Once a template is shared with a team, **all users in that team can access the template**.
<img width="436" alt="Share template" src="https://github.com/user-attachments/assets/22ddde66-7cd9-4e4b-a012-8e1e72043d20"></img>
<img width="436" alt="Share template with team" src="https://github.com/user-attachments/assets/534556ce-1641-44c1-a794-54033ca01376"></img>
---
## 🚫 Deactivating a Team
To deactivate a team, toggle the **Active** switch off. This will:
- Prevent users in this team from logging into their OpenSign accounts.
- Hide the team from the **Teams dropdown** when adding new users.
- Prevent template sharing with deactivated teams.
- Preserve team data for future reactivation and audit purposes.
---
## ℹ️ Notes
- The **All Users** team is the default root and **cannot be deleted**.
- **Deactivated teams** can be re-enabled anytime using the toggle.
- Only users with **administrative privileges** can access and manage the Teams page.
If you require more help, feel free to reach out to our customer support at **support@opensignlabs.com**.
**Happy signing with OpenSign™!**
docs/docs/help/Settings/Webhook.md
+216
View File
@@ -0,0 +1,216 @@
---
sidebar_position: 3
title: Webhook
---
# 🔁 Webhook
## 🔔 What is a Webhook?
A **webhook** allows one system (like OpenSign) to automatically send real-time data or notifications to another system (like your server) when a specific event occurs.
Think of it as a **push notification for your backend** — instead of continuously checking for updates (polling), a webhook pushes data to your endpoint **as soon as an event happens**.
---
## 🧠 Simple Example
Suppose you're using OpenSign to collect eSignatures:
- When someone **signs a document**, OpenSign triggers a **POST request** to your server.
- The request includes data such as the document ID, signer email, and signature status.
- Your server can then process this information — for example, update your CRM, trigger a workflow, or send a confirmation email.
---
## 🧭 How to Add a Webhook in OpenSign
**Step 1:** Log in to your OpenSign account using your credentials.
**Step 2:** Navigate to **Settings → Webhook**.
![Navigate to Add Webhook](https://github.com/user-attachments/assets/6b069b6c-d2b7-408b-b7c9-7fbeb55d6c98)
**Step 3:** Click **Add Webhook**.
- A popup will appear. Enter your **Webhook URL** and click **Yes** to save it.
> **Note:** To enable **Live Webhook** support, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
![Add Webhook](https://github.com/user-attachments/assets/ff68b255-a6e6-4a7d-9cef-6dd9e3b6d4e4)
---
## 🧪 Sandbox Webhook
- You can also add webhook for the **Sandbox** environment on the same page.
- **Sandbox webhook** are available on all plans, including the **Free** plan, and are ideal for development and testing.
> **Caution:** Avoid sending sensitive or confidential data to the Sandbox environment.
📘 **API Reference:**
You can also manage your webhooks via our API.
See the API documentation here: [Save/Update Webhook API](https://docs.opensignlabs.com/docs/API-docs/save-update-webhook)
---
## 📋 Supported Webhook Events
OpenSign sends event notifications to your configured webhook URL when any of the following actions occur:
- **Document Created** – A document is created.
- **Document Viewed** – A signer viewed the document.
- **Document Signed** – A signer signed the document.
- **Document Completed** – All required signatures are completed.
- **Document Revoked or Declined** – The document was revoked or declined.
Each notification is sent as a **POST request** with a **JSON payload** containing relevant event data.
---
### 🔍 Example Payload: `Document Created`
```json
{
"event": "created",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
}
],
"createdAt": "Fri, 16 May 2025 15:02:42 IST"
}
```
### 🔍 Example Payload: `Document Viewed`
```json
{
"event": "viewed",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
}
],
"viewedBy": "peter.mark1093@gmail.com",
"viewedAt": "Fri, 16 May 2025 16:18:16 IST",
"createdAt": "Fri, 16 May 2025 15:02:28 IST"
}
```
---
### 🔍 Example Payload: `Document Signed`
```json
{
"event": "signed",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signer": {
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
},
"signedAt": "Fri, 16 May 2025 16:18:34 GMT+5:30",
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
}
```
---
### 🔍 Example Payload: `Document Completed`
```json
{
"event": "completed",
"type": "request-sign",
"objectId": "kpeg6Q2rO7",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
"certificate": "https://legadratw3d.ams3.digitaloceanspaces.com/9c954912f529acb7e4d065ec0521a63b_certificate.pdf?...",
"name": "Sample Test Doc",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "3556567789"
}
],
"completedAt": "Fri, 16 May 2025 16:18:35 GMT+5:30",
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
}
```
---
### 🔍 Example Payload: `Document Declined`
```json
{
"event": "declined",
"type": "request-sign",
"objectId": "1gtDMBHpEY",
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/e90c32a45351eb52eb00e0054ae50566_581ZmOn4CwAqnxSF.pdf?...",
"name": "Sample Test Doc ",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "Peter Mark",
"email": "peter.mark1093@gmail.com",
"phone": "9283784545554"
}
],
"declinedBy": "peter.mark1093@gmail.com",
"declinedReason": "Invalid date format used.",
"declinedAt": "Fri, 16 May 2025 16:25:38 IST",
"createdAt": "Fri, 16 May 2025 16:24:28 IST"
}
```
---
## ❓ 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 use my Live Webhook in the Sandbox?
No. **Live Webhooks do not work** in the Sandbox environment. You must configure a separate webhook specifically for Sandbox testing.
---
### 3. Can I test all webhook events in the Sandbox?
Yes. The Sandbox environment supports all event types, including `created`, `viewed`, `signed`, `completed`, and `revoked/declined`.
However, some behaviors may be simulated for testing purposes.
---
## 💬 Need Help?
If you need help testing your webhook or integrating it into your application, feel free to reach out to our support team at [support@opensignlabs.com](mailto:support@opensignlabs.com).
**Happy signing with OpenSign™!**
docs/docs/help/Settings/disabledocumentid.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 4
title: Disable DocumentId
---
docs/docs/help/Settings/manage-users.md
+127 -42
View File
@@ -1,52 +1,137 @@
---
sidebar_position: 2
sidebar_position: 6
title: Manage users
---
# User Management
# 👤 User Management
The **User Management** feature allows administrators to add, edit, and manage users within the OpenSign application. This feature is available on self-hosted, teams, and enterprise plans. Only users with "Admin" & "OrgAdmin" role are allowed to manage users.
The **User Management** feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on **Self-Hosted**, **Teams**, and **Enterprise** plans.
## Accessing User Management
1. **Navigate to User management**
- Go to the **Menu**.
- Select **Settings**.
- Click on **Users**.
- A list of existing users will be displayed.
## Adding a New User
To add a new user:
1. **Click the "+" Button**
- Located in the upper right corner of the user list.
2. **Fill in the User Information**
- **Name** (required): Enter the user's full name.
- **Email** (required): Enter the user's email address.
- **Password**: A password is generated automatically. Copy it as it will only be displayed once.
- **Phone** (optional): Enter the user's phone number.
- **Team** (required): Select the team the user belongs to from the dropdown. Teams can be created only on the Teams & Enterprise plans.
- **Role** (required): Select the user's role from the dropdown - OrgAdmin(Has all permissions including user management), Editor(Has all permissions other than user management like creating & sharing templates with teams, User(cannot manager users & cannot share templates with teams but can use templates features for themselves).
![image](https://github.com/user-attachments/assets/d8c3c94e-842d-4f97-bfbc-8a63fc8d62c3)
3. **Submit or Cancel**
- Click **Submit** to add the user.
- Click **Cancel** to discard the changes.
## Managing User Status
- **Toggling Active Status**
- Use the "active" switch next to each user to enable or disable their account.
> ✅ Only users with the roles **Admin** or **OrgAdmin** have permission to access and manage users.
---
For more information, visit our social media channels:
- [Twitter](https://twitter.com/OpenSignHQ)
- [Website](http://www.opensignlabs.com)
- [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
- [LinkedIn](https://www.linkedin.com/company/opensignhq/)
- [YouTube](https://www.youtube.com/@opensignhq)
## 🧭 Accessing User Management
To access the user management panel:
1. Log in to your OpenSign account.
2. In the left-hand sidebar, navigate to **Settings → Users**.
<img width="436" alt="Navigate-to-users" src="https://github.com/user-attachments/assets/9f34201c-fda7-406b-9a78-49a5459269cd"></img>
A list of existing users will be displayed.
---
## ➕ Adding a New User
To add a new user:
1. **Click the ➕ Add User Button**
2. **Fill in the User Information**
| Field | Required | Description |
|--------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Name** | ✅ Yes | Enter the user's full name. |
| **Email** | ✅ Yes | Enter a valid email address. |
| **Password** | ✅ Yes | The system auto-generates a password. **Copy it immediately** as it will be shown only once. |
| **Phone** | ❌ No | (Optional) Enter the user’s phone number. |
| **Team** | ✅ Yes | Select the team the user belongs to from the dropdown.<br>_Note: Teams must be created beforehand under **Settings → Teams** (available in Teams & Enterprise plans)._ |
| **Role** | ✅ Yes | Choose one of the following roles: |
| | | - **OrgAdmin**: Full access, including user and team management. |
| | | - **Editor**: Can create and share templates but **cannot manage users**. |
| | | - **User**: Can use templates for signing but **cannot share** them or manage users. |
<img width="436" alt="Add-user-form" src="https://github.com/user-attachments/assets/c176dd4f-257d-42e2-be7f-a05a1f7e4094"></img>
3. **Submit or Cancel**
- Click **Submit** to create the user.
- Click **Cancel** to exit without saving.
> 🔒 **Note:** Once a user is created, the password will not be visible again. If needed, you can use the **"Forgot Password"** option on the login page to reset it.
<img width="436" alt="new user" src="https://github.com/user-attachments/assets/647c40d8-061d-4e0a-b62c-302296e83493"></img>
---
## 🔁 Managing User Status
- **Activate/Deactivate Users**
- Use the toggle in the **Active** column to enable or disable a user’s account.
- **Deactivated users** will not be able to log in to OpenSign until reactivated.
---
## 🔐 Permissions by Role
| Role | Manage Users | Create Templates | Share Templates with Teams | Use Templates |
|-------------|---------------|------------------|-----------------------------|---------------|
| **OrgAdmin** | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
| **Editor** | ❌ No | ✅ Yes | ✅ Yes | ✅ Yes |
| **User** | ❌ No | ✅ Yes | ❌ No | ✅ Yes |
---
## 👥 Buy More Users (Buy Additional Seats)
OpenSign allows you to create users based on the number of seats included in your selected plan. For example, if your current plan includes **2 users**, you can only create **2 users** by default. To add a **third user**, you must **purchase additional seats**.
### Steps to Buy More Users
1. **Click "Buy more users"**
2. A popup titled **Add Seats** will appear.
3. **Enter Quantity** – specify how many additional users (seats) you want to purchase.
4. The **cost** will be calculated automatically based on your plan rate (e.g., USD 100 per user).
5. Click the **Proceed** button to finalize the purchase.
6. The seats will be **immediately added** to your account.
<img width="436" alt="buy-more-seats" src="https://github.com/user-attachments/assets/2e093a64-1b75-4543-b4c4-1186d4c02b09"></img>
7. Once you’ve purchased additional seats, click the **"+" Add User** button to create the new user.
> 💡 **Tip:** You can also purchase additional seats in advance to avoid interruptions during user onboarding.
---
### 🔢 Understanding "Available Seats"
At the bottom-right of the **Users** page, you’ll see the **Available seats** status.
<img width="436" alt="seat-availability" src="https://github.com/user-attachments/assets/37c2a5c7-0d4b-4bd2-8fb1-11def9e65b42"></img>
**Example:**
`Available seats: 2/3`
This means:
- **2 seats** are currently available for creating new users.
- **3** is the **total number of user seats** your organization has purchased.
If the available seats count is **0**, you must **buy more seats** before adding new users.
---
## 📌 Frequently Asked Questions (FAQ)
**Q: How do I pay for purchased add-on users?**
**A:** After purchasing additional users (seats), your saved card will be charged automatically, and an invoice will be emailed to your registered address.
If no card is on saved, a payment link will be sent to your email to complete the transaction.
---
## 📣 Need Help?
If you need further assistance, feel free to reach out to our customer support at **support@opensignlabs.com**.
For more support and updates, follow us on:
- 🌐 [Website](http://www.opensignlabs.com)
- 🐦 [Twitter](https://twitter.com/OpenSignHQ)
- 📘 [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
- 💼 [LinkedIn](https://www.linkedin.com/company/opensignhq/)
- 📺 [YouTube](https://www.youtube.com/@opensignhq)
---
Happy signing with **OpenSign™**!