StardDevelopersداشبورد

بررسی کلید

GET/api/v1/ping
بدون scopeاحراز هویت: Bearerlive و test

ساده‌ترین درخواست: کلید را بررسی می‌کند و محیط (live/test)، شناسه‌ی حساب و scopeهای کلید را برمی‌گرداند. برای تست اتصال و health-check یکپارچه‌سازی مناسب است.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…

نمونه

curl "https://stard-market.ir/api/v1/ping" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 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

خطاها

HTTPcodeکی
401invalid_api_key / missing_api_key / api_key_revoked / api_key_expiredکلید نیامده، نامعتبر، باطل یا منقضی است
429rate_limit_exceededسقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست

محدودیت نرخ

پیش‌فرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمی‌گردد — جزئیات.