بررسی کلید
GET
/api/v1/pingبدون scopeاحراز هویت: Bearerlive و test
سادهترین درخواست: کلید را بررسی میکند و محیط (live/test)، شناسهی حساب و scopeهای کلید را برمیگرداند. برای تست اتصال و health-check یکپارچهسازی مناسب است.
درخواست
| نام | محل | نوع | توضیح | |
|---|---|---|---|---|
Authorization | header | string | الزامی | Bearer sk_live_… یا Bearer sk_test_… |
نمونه
curl "https://stard-market.ir/api/v1/ping" \
-H "Authorization: Bearer $STARD_API_KEY"const res = await fetch("https://stard-market.ir/api/v1/ping", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
},
});
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/ping", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
},
});
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.get(
"https://stard-market.ir/api/v1/ping",
headers={
"Authorization": f"Bearer {os.environ['STARD_API_KEY']}",
},
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/ping");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("STARD_API_KEY"),
],
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"
)
func main() {
req, _ := http.NewRequest("GET", "https://stard-market.ir/api/v1/ping", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("STARD_API_KEY"))
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": "ping",
"ok": true,
"environment": "test",
"developer": "dev_8Kq2Lm4Np6Rs8Tu0Vw2X",
"key": {
"id": "key_5Gh8Jk1Lm4Np7Qr0St3V",
"display": "sk_test_VDhoHnI5…Jxjs",
"scopes": [
"orders:read",
"orders:write",
"prices:read",
"products:read",
"wallet:read",
"webhooks:read"
]
},
"server_time": "2026-10-01T10:31:42Z"
}هدرهای پاسخ
x-request-id: req_yYgWsdRadtPqc3YwtyCC
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
x-ratelimit-reset: 1790850720خطاها
| HTTP | code | کی |
|---|---|---|
401 | invalid_api_key / missing_api_key / api_key_revoked / api_key_expired | کلید نیامده، نامعتبر، باطل یا منقضی است |
429 | rate_limit_exceeded | سقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست |
محدودیت نرخ
پیشفرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمیگردد — جزئیات.
