StardDevelopersداشبورد

وضعیت ممبر با ربات

GET/api/v1/services/members/invite/{token}
scope: orders:readاحراز هویت: Bearerlive و test

pending تا وقتی ربات ادمین نشده؛ بعد done با order (همراه order.members: joined/left/net) یا failed با error.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…
tokenpathstringالزامیتوکن از پاسخ invite

نمونه

curl "https://stard-market.ir/api/v1/services/members/invite/AbC123" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 200
{
  "object": "member_invite",
  "environment": "test",
  "token": "AbC123",
  "status": "pending",
  "order": null
}
هدرهای پاسخ
content-type: application/json

کاربرد و نکته‌ها

کی به کار می‌آید؟ بعد از POST /services/members/invite، برای اینکه بفهمی صاحب کانال ربات را ادمین کرده یا نه و سفارش ممبر ثبت شده است. pending یعنی هنوز ادمین نشده؛ done همراه شیء order و آمار order.members (عضوشده، خارج‌شده، خالص)؛ failed همراه error.

  • فقط درخواست‌هایی که با کلید همان حساب API ساخته شده‌اند قابل خواندن‌اند؛ بقیه 404 not_found می‌دهند.
  • chat_title نام کانال یا گروهی است که ربات در آن ادمین شد؛ برای تأیید اینکه ربات در کانال درست ادمین شده آن را نشان بده.

خطاها

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

محدودیت نرخ

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