پرش به محتویات

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

خوش آمدید 👋

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

🚀 شروع سریع

1. نصب وابستگی‌ها

cd /home/mahdi/Projects/ice/docs-p2p
uv add mkdocs mkdocs-material

2. اجرای مستندات

uv run mkdocs serve --dev-addr 0.0.0.0:8000

3. دسترسی

http://localhost:8000

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

معرفی سیستم

مبانی API

منطق دامنه

رفرنس API

🔑 نکات کلیدی

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

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

  1. GET /{resource} - لیست‌گیری

  2. POST /{resource} - ایجاد

  3. POST /{resource}/{uid} - دریافت

  4. PATCH /{resource}/{uid} - به‌روزرسانی

  5. DELETE /{resource}/{uid} - حذف

✅ احراز هویت

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

Authorization: Bearer <your_jwt_token>

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

تمامی مستندات از متغیرهای زیر استفاده می‌کنند: - {{ USSO_BASE_URL }} - آدرس احراز هویت - {{ API_BASE_URL }} - آدرس API اصلی

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

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

  1. راهنمای سریع (۵ دقیقه)
  2. احراز هویت (۱۰ دقیقه)
  3. نمونه‌های cURL (۱۵ دقیقه)

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

  1. REST Maturity Level 2
  2. قراردادها
  3. رفرنس API مورد نظر
  4. منطق بازار

💡 مثال سریع

# 1. دریافت توکن
ACCESS_TOKEN=$(curl -X 'POST' \
  'https://app.uln.me/api/sso/v1/auth/signin' \
  -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"}'

📞 پشتیبانی

موفق باشید! 🚀