مستندات API بازار اسکناس همتا به همتا¶

خوش آمدید 👋¶

این مستندات راهنمای جامع برای یکپارچه‌سازی با API بازار اسکناس همتا به همتا (P2P) است.

📚 محتوای مستندات¶

معرفی سیستم¶

کلیات سیستم - آشنایی کلی با سیستم
بازار اسکناس P2P - مفهوم بازار همتا به همتا

مبانی API¶

REST Maturity Level 2 - استانداردهای طراحی
احراز هویت - سیستم JWT و توکن‌ها
قراردادها - قراردادهای API
صفحه‌بندی - صفحه‌بندی و فیلترینگ
خطاها - مدیریت خطاها

منطق دامنه¶

منطق بازار - گردش کار معاملاتی
چرخه عمر سفارش - زندگی یک سفارش

رفرنس API¶

User API - مدیریت کاربران
Wallet API - مدیریت کیف پول‌ها
Market Symbols - نمادهای معاملاتی
Market Sessions - جلسات معاملاتی
Orders API - سفارشات
Trades API - معاملات
Market Data - داده‌های بازار

🔑 نکات کلیدی¶

✅ ۵ اندپوینت اصلی¶

هر ریسورس دارای ۵ اندپوینت استاندارد است:

GET /{resource} - لیست‌گیری
POST /{resource} - ایجاد
POST /{resource}/{uid} - دریافت
PATCH /{resource}/{uid} - به‌روزرسانی
DELETE /{resource}/{uid} - حذف

✅ احراز هویت¶

تمامی درخواست‌ها نیاز به JWT Token دارند:

Authorization: Bearer <your_jwt_token>

✅ متغیرهای پایه¶

تمامی مستندات از متغیرهای زیر استفاده می‌کنند: - $BASE_URL - آدرس API اصلی

🎯 مسیر یادگیری پیشنهادی¶

برای تازه‌کارها¶

احراز هویت (۱۰ دقیقه)

برای توسعه‌دهندگان¶

💡 مثال سریع¶

# 1. دریافت توکن
ACCESS_TOKEN=$(curl -X 'POST' \
  'https://app.uln.me/api/user/v1/auth/login' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "client_id": "client_id",
  "client_secret": "client_secret"
}' | jq -r .tokens.access)

# 2. مشاهده نمادها
curl -X GET "{{ API_BASE_URL }}/api/exchange/v1/symbols" \
  -H "Authorization: Bearer $JWT_TOKEN"

# 3. مشاهده قیمت
curl -X GET "{{ API_BASE_URL }}/api/exchange/v1/tickers/USD-IRR"

# 4. ثبت سفارش
curl -X POST "{{ API_BASE_URL }}/api/exchange/v1/orders" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -d '{"symbol":"USD-IRR","side":"buy","type":"limit","price":"1000000000","quantity":"100"}'

📞 پشتیبانی¶

ایمیل: mahdikiany@gmail.com
Exchange Swagger: https://app.uln.me/api/exchange/v1/docs
Wallet Swagger: https://app.uln.me/api/accounting/v1/docs

موفق باشید! 🚀