رفتن به محتوای اصلی
سرویکس وب‌سرویس و API داده‌های بازار ایران
فهرست مستندات

شروع سریع

شروع کار با API سرویکس

حساب سرویکس بسازید، از شروع رایگان دائمی استفاده کنید، یک کلید API بسازید و بدون فعال‌سازی آزمایشی نخستین درخواست احرازشده را بفرستید.

این راهنما کوتاه‌ترین مسیر از ساخت حساب تا دریافت نخستین پاسخ احرازشده سرویکس است. هر حساب، شروع رایگان دائمی با روزانه ۵۰ درخواست، یک کلید API فعال و دسترسی به همهٔ اندپوینت‌های مستند دارد. نه فعال‌سازی آزمایشی لازم است و نه اطلاعات پرداخت.

۱. حساب بسازید

ثبت‌نام کنید یا وارد حساب شوید. شروع رایگان همان لحظه در دسترس است و تاریخ انقضا ندارد.

۲. کلید API بسازید

در بخش Profile > API Keys یک کلید فعال بسازید. کلید را در سامانهٔ مدیریت اسرار یا متغیر محیطیِ سرور نگه دارید؛ آن را در کد مرورگر، URL، مخزن عمومی یا پیام پشتیبانی قرار ندهید.

۳. نخستین درخواست را بفرستید

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "X-API-Key: <your-api-key>"

قرارداد دقیق پاسخ، فیلد quoteUnit را دارد. واحد را از همین فیلد نمایش دهید و از روی نام نماد حدس نزنید.

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>"
}

۴. اتصال را کامل کنید

امنیت کلید API، قیمت‌های جاری، کاتالوگ احرازشده و خطاها و سهمیه را بخوانید. افزونه وردپرس نیز با شروع رایگان کار می‌کند.

ادامهٔ مسیر با Vue 3 و Pinia

اگر برنامهٔ مرورگری می‌سازید، راهنمای تست‌شدهٔ Vue 3، Pinia و Composition API را دنبال کنید. در این نمونه، کلید API سرویکس پشت پراکسی هم‌مبدأ در بک‌اند می‌ماند و وضعیت تایپ‌شدهٔ رابط کاربری به قرارداد اصلی سرویس وصل می‌شود.