شبیهسازی نتیجهی سفارش (test)
POST
/api/v1/test/orders/{id}/simulatescope: orders:writeاحراز هویت: Bearerlive و test
فقط با کلید sk_test_: نتیجهی یک سفارش آزمایشی را تعیین کن تا کد و وبهوکهایت را برای همهی حالتها تست کنی. failed و refunded موجودی آزمایشی را برمیگردانند. بدون شبیهسازی، سفارش test بعد از ۱۵ ثانیه خودکار completed میشود.
درخواست
| نام | محل | نوع | توضیح | |
|---|---|---|---|---|
Authorization | header | string | الزامی | Bearer sk_live_… یا Bearer sk_test_… |
id | path | string | الزامی | کد پیگیری سفارش (ord_… یا کد live) |
بدنه (JSON)
| فیلد | نوع | توضیح | |
|---|---|---|---|
outcome | string | الزامی | processing، completed، failed یا refunded |
نمونه
curl -X POST "https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate" \
-H "Authorization: Bearer $STARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"outcome": "failed"}'const res = await fetch("https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"outcome": "failed"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);type StardError = { error: { type: string; code: string; message: string; param: string | null; request_id: string } };
const res = await fetch("https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"outcome": "failed"
}),
});
if (!res.ok) {
const { error } = (await res.json()) as StardError;
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const data: Record<string, unknown> = await res.json();import os
import requests
r = requests.post(
"https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate",
headers={
"Authorization": f"Bearer {os.environ['STARD_API_KEY']}",
},
json={
"outcome": "failed"
},
timeout=20,
)
data = r.json()
if r.status_code >= 400:
raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)<?php
$ch = curl_init("https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("STARD_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"outcome" => "failed"
]),
CURLOPT_TIMEOUT => 20,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) {
throw new RuntimeException($data["error"]["code"] . ": " . $data["error"]["message"]);
}
print_r($data);package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"outcome": "failed"}`)
req, _ := http.NewRequest("POST", "https://stard-market.ir/api/v1/test/orders/ord_test_gGToQWxqOw89ssiL/simulate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("STARD_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
b, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(b))
}پاسخ — 200
{
"object": "order",
"id": "ord_test_etbvDNYC7E4k8vEP",
"order_id": null,
"environment": "test",
"status": "failed",
"raw_status": "failed",
"title": "⭐ 50 استارز برای @username (test)",
"product_id": null,
"product_tag": null,
"type": "stars",
"quantity": 50,
"recipient": "@username",
"amount": {
"amount": 224900,
"currency": "IRT"
},
"paid": {
"amount": 224900,
"currency": "IRT"
},
"failure_reason": "simulated",
"metadata": {},
"created_at": "2026-10-02T17:43:25Z",
"updated_at": "2026-10-02T17:43:25Z"
}هدرهای پاسخ
content-type: application/json
x-request-id: req_FkPUX928OypWAvZNCRFd
x-ratelimit-limit: 1000
x-ratelimit-remaining: 975خطاها
| HTTP | code | کی |
|---|---|---|
403 | test_only | با کلید live |
409 | order_final | سفارش در وضعیت نهایی است |
403 | insufficient_scope | کلید scope orders:write را ندارد |
401 | invalid_api_key / missing_api_key / api_key_revoked / api_key_expired | کلید نیامده، نامعتبر، باطل یا منقضی است |
429 | rate_limit_exceeded | سقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست |
محدودیت نرخ
پیشفرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمیگردد — جزئیات.
