إنتقل إلى المحتوى الرئيسي

مرجع API لوحة التحكم

مرجع كامل لنقطة نهاية API لوحة التحكم. استخدمها لعرض ملخص روابط الدفع والـ intents والمعاملات والأرصدة الخاصة بالتاجر.

الرابط الأساسي​

https://api.orcarail.com/api/v1

الحصول على ملخص لوحة التحكم​

احصل على ملخص لوحة تحكم المستخدم المصادَق عليه: المجاميع (الروابط، والـ intents، والمعاملات، وUSDC المكتسب/المسحوب/المتبقي)، وسلسلة الحجم، والمعاملات الأخيرة.

GET /dashboard/summary

المصادقة​

  • رمز Bearer (JWT) — مطلوب

الاستجابة​

{
  "totals": {
    "links": 12,
    "intents": 8,
    "transactions": 42,
    "totalEarnedUsdc": "1250.50",
    "withdrawnUsdc": "500.0",
    "remainingUsdc": "750.5"
  },
  "volumeSeries": [
    {
      "month": "2026-01",
      "transactionCount": "42"
    },
    {
      "month": "2025-12",
      "transactionCount": "38"
    }
  ],
  "recentTransactions": [
    {
      "id": 101,
      "status": "confirmed",
      "amount": "0.25",
      "amountReceived": "0.25",
      "createdAt": "2026-01-22T10:45:12.123Z",
      "paymentLinkTitle": "Subscription January",
      "paymentLinkSlug": "550e8400e29b41d4a716446655440000",
      "tokenSymbol": "USDC",
      "networkName": "Ethereum",
      "payerTokenSymbol": "ETH",
      "payerAmount": "0.0012"
    }
  ]
}

حقول الاستجابة​

الحقلالنوعالوصف
totals.linksnumberعدد روابط الدفع
totals.intentsnumberعدد الـ payment intents
totals.transactionsnumberعدد المعاملات
totals.totalEarnedUsdcstringإجمالي الحجم المكتسب بـ USDC
totals.withdrawnUsdcstringإجمالي المسحوب بـ USDC
totals.remainingUsdcstringالرصيد المتبقي بـ USDC
volumeSeriesarrayعدد المعاملات الشهري (الشهر بصيغة YYYY-MM)
recentTransactionsarrayالمعاملات الأخيرة مع رابط الدفع ومعلومات الرمز/الشبكة

رموز الحالة​

رمز الحالةالوصف
200نجاح
401غير مصرّح
500خطأ داخلي في الخادم

انظر أيضًا​