Free
UChat Official
Introduction
In this detailed overview, we explore the functionalities, setup procedures, and benefits of the sandbox environment provided by the platform.
Designed primarily for developers and partners, the sandbox allows for seamless testing of API calls, feature integrations, and account modifications without affecting real user data or incurring charges.
This summary aims to clarify how to access, utilize, and maximize the sandbox environment effectively, ensuring users can confidently develop and debug their applications.
Understanding the Sandbox Environment
What is the Sandbox?
The sandbox is a dedicated testing workspace that mimics the live environment but operates independently. It enables users to:
Test API calls without deducting credits from their actual wallet.
Simulate upgrades, cancellations, and other account modifications.
Verify backend processes such as bot additions, member management, and auto-renewal settings.
How to Access the Sandbox
To activate the sandbox, users must:
Send a support ticket or contact the platform representative (e.g., Matthew).
The support team or representative will invite or add the sandbox to the user's workspace.
Note: The sandbox is not automatically available; it requires explicit request and setup.
Visual Indicators of the Sandbox
Once added, users will notice:
Feature | Description |
|---|---|
Workspace Label | The workspace will be labeled "sandbox" for easy identification. |
Credit Balance | The sandbox maintains a separate credit balance (e.g., 1756 credits). |
Sandbox Purchase Record | All test transactions are logged here, distinct from real transactions. |
Key Characteristics
No real charges: Upgrades or modifications within the sandbox do not deduct credits.
Isolated environment: Changes made here do not impact the live environment or wallet.
Testing flexibility: Users can simulate various scenarios, including upgrades, cancellations, and auto-renewal toggling.
How to Use the Sandbox Effectively
Step-by-Step Workflow
Obtain Access:
Reach out via support or directly to the platform contact.
Receive an invitation to the sandbox workspace.
Identify Workspace ID:
The sandbox workspace has a unique workspace ID.
Always use this ID in your API calls to ensure testing occurs within the sandbox.
Perform API Calls:
Use the platform's pattern APIs with the sandbox workspace ID.
Test various operations such as:
Adding or removing bot users.
Managing members.
Upgrading or downgrading plans.
Toggling auto-renewal.
Verify Backend Changes:
Check the backend dashboard to confirm:
Successful addition or removal of bots/members.
Correct application of upgrades or cancellations.
Auto-renewal status.
Monitor Credits and Records:
Credits in the sandbox are not deducted.
Review the sandbox purchase record for all test transactions.
Important Tips
Always use the sandbox workspace ID in your API requests.
Remember that test transactions do not affect your real wallet.
To reset or clear test data, contact support or your platform representative.
Use the sandbox to simulate edge cases and debug issues before deploying to production.
Testing Specific Features
Feature | How to Test | Expected Outcome |
|---|---|---|
Upgrading Workspace | Make an upgrade API call | Credits remain unchanged; the upgrade is reflected in backend |
Cancelling Subscription | Send cancellation request | Subscription is canceled in sandbox; no real charges |
Auto-Renew Toggle | Enable or disable auto-renew | Changes are reflected in backend; no impact on real account |
Adding/Removing Bots | Use API to add or remove bots | Backend reflects changes; no real impact or charges |
Maximizing the Sandbox Experience
The sandbox environment is an invaluable tool for developers and partners aiming to test, debug, and refine their integrations without risking real data or incurring costs. By following the outlined procedures—obtaining access, correctly identifying the workspace ID, and performing API calls within this isolated environment—users can confidently develop features, troubleshoot issues, and ensure smooth deployment to the live environment.
Remember:
Always reach out to support or your platform contact to enable sandbox access.
Use the sandbox exclusively for testing; it provides a safe space to experiment.
Keep track of your sandbox credits and purchase records to monitor test activities.
When ready, transition tested features to production with confidence.
Final Thoughts
The sandbox is a powerful, flexible environment designed to streamline development workflows and enhance user confidence. Proper utilization ensures that integrations are robust, issues are identified early, and the transition to live deployment is seamless. Embrace the sandbox as an essential part of your development toolkit, and leverage it to build reliable, efficient, and user-friendly applications.