How to Test RukkyHub API Requests Using the API Sandbox

How to Test RukkyHub API Requests Using the API Sandbox

The RukkyHub API Sandbox helps developers test API requests before connecting an application to live services. It provides a testing interface with pre-built request fields and code examples for supported API actions.

Using the sandbox during development helps you check request parameters, authentication, and response handling before deploying your integration.

What Is the RukkyHub API Sandbox?

The API Sandbox is an online testing environment available through the RukkyHub Developer Portal. It lets you enter an API key, select a supported action, supply the required parameters, and inspect the response.

Test API keys use the rk_test_ prefix and simulate purchase responses. Live API keys use the rk_live_ prefix and can execute real requests. Always confirm which type of key you are using before sending a request.

Step 1: Open the API Sandbox

1. Visit the official RukkyHub API Sandbox.
2. Review the available API actions.
3. Choose the action you want to test, such as checking your balance or listing SMM services.
4. Enter the appropriate test API key when prompted.

Use the official developer portal and keep your API credentials private. Do not share your key with other people or include it in public screenshots.

Step 2: Choose a Simple API Action

If you are new to the API, start with an action that does not place an order or initiate a purchase.

Two useful starting points are:

• Balance: uses action=balance to request account balance information.
• Services: uses action=services to request the available SMM services.

These requests help you check whether your authentication and basic request structure are working before testing more complex actions.

Step 3: Enter the Required Parameters

Each API action has its own required parameters. The sandbox displays fields for the selected action, where applicable.

• For a balance request, select the balance action.
• For an SMM services request, select the services action.
• For an order-status request, provide the relevant order ID.
• For other actions, consult the fields and instructions shown in the sandbox and the official API reference.

Check spelling, parameter names, and required values before sending the request. A missing or incorrectly named parameter can cause an API error.

Step 4: Send the Request and Inspect the Response

Use the sandbox's request button to submit your test. Review the returned JSON response and check whether it contains the expected information or an error message.

When testing, pay attention to:

• Whether the request was accepted.
• Whether the response contains the fields your application expects.
• Whether an error message identifies missing parameters, invalid credentials, or insufficient permissions.
• Whether your application handles both successful and unsuccessful responses appropriately.

A successful test response is useful evidence that the request was accepted in the test environment. It does not, by itself, guarantee that a live transaction will succeed.

Step 5: Use the Generated Code Examples

The sandbox provides code examples for supported actions in languages including cURL, PHP, Python, and JavaScript. Use the example for your chosen action as a starting point for your own integration.

The RukkyHub API uses a single endpoint:

https://developers.rukkyhub.com/api/v1

Requests use the POST method and form-encoded parameters. The recommended authentication method is the X-API-KEY HTTP header.

For example, a basic balance request using cURL has this structure:

curl -X POST https://developers.rukkyhub.com/api/v1 \  -H "X-API-KEY: YOUR_TEST_API_KEY" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d "action=balance"

Replace the placeholder with an appropriate test key stored securely. Never place a live secret key in public frontend code or a public repository.

Step 6: Test Error Handling

Testing should include more than successful requests. Check how your application responds when the API returns an error.

• Confirm that your application can display a useful message when a required parameter is missing.
• Check how invalid or insufficient API permissions are handled.
• Ensure that unexpected response data does not crash your application.
• Record enough diagnostic information to troubleshoot problems without logging API keys, PINs, or other secrets.

Use the official RukkyHub API Error Codes page to understand documented error messages.

Step 7: Test Relevant Actions Before Deployment

After your initial request works, test each API action your application actually needs. For example, an SMM integration may need to list services, submit orders, and check order status. A VTU integration will require the relevant VTU actions and permissions.

Make sure your API key has the appropriate scopes and your API access plan supports the actions you intend to use.

For purchase-related actions, verify the documented parameters and transaction requirements. Test keys simulate purchase responses; do not assume that a test response proves a real purchase has been completed.

Step 8: Prepare for Live Integration

Before deploying your application:

1. Confirm that your API access plan is active and approved where required.
2. Verify that your API key has the necessary scopes.
3. Store credentials securely on your backend server.
4. Confirm that any configured IP or domain restrictions match your deployment environment.
5. Review the API reference and error documentation for each action you use.
6. Switch to live credentials only when you are ready to process real requests.
7. Monitor responses and handle failed or uncertain transactions carefully.

Live keys can execute real requests. Never use a live key casually for experiments that could create orders or initiate purchases.

Common Sandbox Testing Problems

The API key is rejected.

Check that the key is valid, copied correctly, and suitable for the environment you are testing. Review the authentication documentation if the problem persists.

The API returns an invalid action error.

Check the action name against the official API reference and ensure the required action parameter is included.

The request is missing required fields.

Review the fields displayed for the selected action and compare them with the official API reference. Required parameters differ between actions.

An action is not permitted.

Check the API key's scopes and confirm that your plan supports the requested feature.

A test response differs from a live result.

Test keys simulate purchase responses. Live processing may depend on account status, service availability, valid transaction details, and other live conditions.

Official RukkyHub Developer Resources

• API Sandbox — test supported actions and view code examples.
• Getting Started — learn how to obtain API access and create an API key.
• Authentication — understand API keys, scopes, and security restrictions.
• API Reference — review supported actions and parameters.
• Error Codes — troubleshoot API errors.

Frequently Asked Questions

Does the API Sandbox use real transactions?

Test keys with the rk_test_ prefix simulate purchase responses. Live keys with the rk_live_ prefix can execute real requests.

Can I use the sandbox to test every API action?

The sandbox provides a testing interface for supported actions. Check the sandbox and API reference for the specific actions and parameters available.

Does a successful sandbox test guarantee live success?

No. A test confirms how your request behaves in the test environment. Live requests may depend on live account access, service availability, transaction details, and other conditions.

Where can I get help if my test keeps failing?

Review the official authentication guide, API reference, and error codes. If you contact support, provide the action, the error message, and relevant non-sensitive request details. Do not send your complete API key or PIN.