URL API Documentation
1. Global Endpoint2. Request Parameters3. Supported Output Formats4. Response Schema (JSON Example)5. Multi-Format Implementation (PHP)6. Specialized Queries7. Error Codes ReferencePro-Tip For Users
1. Global Endpoint
All API requests must be sent via POST to the following URL:
https://your-domain.com/api/url
2. Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| key | String | Yes | Your unique API authorization key. |
| service | Mixed | Yes | ID, for example , or prices to get your latest service rate card. |
| imei | String | Optional* | The IMEI, serial number, or one supported input value for the selected service. |
| order_id | String | No | Query an existing paid result by order ID without deducting balance again. |
| format | String | No | Output type. Default is json. |
3. Supported Output Formats
Set the format parameter to return the response in the structure your workflow needs.
JSONPHPHTMLXMLTXTCSVMarkdown
4. Response Schema (JSON Example)
When using the default JSON format, the response includes transaction details, pricing, balance, and a structured object when the service returns extra parsed data.
{
"success": true,
"order_id": "MDM_987654321",
"service_number": 314,
"price": "1.50",
"balance": "48.50",
"response": "Model: iPhone 15 Pro\nStatus: Clean",
"object": {
"model": "iPhone 15 Pro",
"capacity": "256GB",
"status": "Clean"
}
}5. Multi-Format Implementation (PHP)
<?php
$apiUrl = "https://your-domain.com/api/url";
$postData = [
"key" => "YOUR_API_KEY",
"service" => 314,
"imei" => "35492XXXXXXXXXX",
"format" => "json"
];
$ch = curl_init($apiUrl);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
if (!empty($result["success"])) {
echo "Order ID: " . $result["order_id"] . PHP_EOL;
echo "Balance: " . $result["balance"] . PHP_EOL;
echo "Data: " . $result["response"] . PHP_EOL;
}
?>6. Specialized Queries
Get Price List
Send service=prices to retrieve the current public rate list tied to your API key.
Get Order History
Send an existing order_id=MDM_XXXXX to pull the old result again without charging the balance a second time.
7. Error Codes Reference
| Error | Description |
|---|---|
| INVALID_KEY | The API key is missing, disabled, or incorrect. |
| LOW_BALANCE | Your wallet balance is not enough to complete the request. |
| NOT_FOUND | The requested service ID or order ID does not exist. |
Pro-Tip For Users
Use a test service first to confirm your request format, then switch the same payload to the final paid service ID. This keeps integrations safer when you update domains or change upstream mappings later.