Merge pull request #2052 from pravinOpenSign/patch-50

Patch 50
This commit is contained in:
prafull-opensignlabs
2025-12-10 17:49:21 +05:30
committed by GitHub
2 changed files with 63 additions and 1 deletions
+29
View File
@@ -41,6 +41,35 @@ Youll also find the option to generate a **Sandbox API Token** on the same pa
<img width="436" alt="Sandbox api token" src="https://github.com/user-attachments/assets/f27d9e00-7989-4c01-b23e-cecaccce4be2" />
### 🧪 API Credits
**Premium Credits Available:**
Displays the total API credits available for your organisation.
**Your Credits Usage:**
- **Used Credits:** The number of credits you have consumed.
- **Remaining Credits:** The number of credits still available for you to use.
<img width="436" alt="API credit" src="https://github.com/user-attachments/assets/e0d87fb2-7391-4bad-b668-9ce2b558c52d" />
### Where API Credits Are Deducted
API credits are consumed whenever a document is created through the following actions:
- **Self Sign API:** Credits deducted when a document is created.
- **Draft Document API:** Deducted when drafting a document.
- **Create Document API:** Deducted on document creation.
- **Draft Template API:** Deducted when:
- Sending a document if signers are already assigned,
- Bulk sending,
- Creating documents using public templates (signer fills details and finish).
- **Create Document From Template API:** Deducted on document creation.
### In the OpenSign Application
- **Manage Templates → Bulk Send:** Credits are deducted for each document created.
- **Public Template Signing:** Credits are deducted when a document is created during public signing (when the signer enters details and completes the process).
### 🧪 Sandbox Cloud Account Login
OpenSign provides a **sandbox testing cloud environment**, which is a replica of the production environment. This allows users to test features without affecting live data.
+34 -1
View File
@@ -73,7 +73,40 @@ To add a new user:
3. Enter the users email in the input box and click **Delete**.
- After deletion, the user (and all related data) will be permanently erased.
> ⚡ **Note:** Once a user is deleted, your **available user count will automatically increase**.
> ⚡ **Note:** Once a user is deleted, your **available user count will automatically increase**.
## 🔁 Change Password
- OpenSign allows **admins** to update a team user's password whenever required.
- **To change a users password:**
1. Navigate to **Settings → Users** and click the **Change Password** button next to the user whose password needs to be updated.
2. Enter the new password on the reset password screen and submit.
- The users password will be successfully updated, and they will no longer be able to log in using the old password.
## 🔁 Add API Credits
- OpenSign allows **admins to assign API credits** to team users. This feature helps control and limit how many API-based document operations a user can perform.
- A team user can only use the number of credits allocated by the admin.
- For example, if an admin assigns **100 API credits**, the user can perform API actions only until those 100 credits are consumed.
- Once credits are exhausted, the admin can add more.
- Example: If the admin wants to give the user 50 additional credits, they must enter the updated total — 150 credits. After updating, the user will have 50 usable credits remaining.
- **How to add API credits:**
1. Navigate to **Settings → Users** and click the **Add Credits** button next to the user who needs add API credits.
2. Enter the number of credits to allocate and submit.
- The user will now be able to use the assigned API credits up to the new limit.
> ⚡ **Note:** Credits can only be added if the selected user has an active API token.
**How to create an API token for a team user:**
1. Log in using the team user's email address.
2. Navigate to **Settings → API Token**.
3. Generate a live API token.
Once the API token is created, the admin can assign API credits to that user.
---