توثيق API

اليوم

/api Live

واجهة برمجة التطبيقات ذات الإصدارات

/api/v1 Published contract, not open

الإصدار موجود في المسار، وليس في ترويسة: يجب أن يتحمل عنوان URL لصقه في تذكرة. التغيير الجذري — حقل محذوف، نوع مُغيَّر، دلالات مختلفة — يفتح إصدارًا جديدًا؛ ويستمر تقديم الإصدار السابق لمدة ستة أشهر على الأقل، مع الإعلان عن تاريخ انتهائه في سجل التغييرات. إضافة حقل ليس تغييرًا جذريًا: يجب على عميلك تجاهل الحقول التي لا يعرفها.

curl -sS -X POST https://fiatside.com/api/quote \
  -H 'Content-Type: application/json' \
  -d '{
    "assetId": "usdt",
    "railId": "sepa_instant",
    "networkId": "tron",
    "direction": "sell",
    "amount": "1000"
  }'

{
  "deposit": { "amount": "1000.000000", "ticker": "USDT", "decimals": 6 },
  "gross": "921.68",
  "net": "912.28",
  "currency": "EUR",
  "currencyDecimals": 2,
  "midRate": "0.92168430",
  "effectiveRate": "0.91228000",
  "totalCostBps": 102,
  "lines": [
    { "code": "network", "amount": "1.11", "basis": "Cout reseau tron, preleve en USDT" },
    { "code": "spread",  "amount": "8.29", "basis": "0.90 % du montant converti" }
  ],
  "settlement": { "p50Minutes": 1, "p95Minutes": 12 },
  "lockSeconds": 1800,
  "rateAsOf": 1788356981608,
  "rateSource": "mock",
  "limitError": null
}

حقل rateSource يوضح من أين جاء السعر. القيمة "mock" هي المصدر التنموي الحتمي، الذي لا يمكن تشغيله في الإنتاج: العملية ترفض البدء بدلاً من تسعير أسعار مجمدة.

• المصادقةكيف تتم حماية نقطة نهاية عرض السعر اليوم، وكيف سيتم إصدار المفاتيح، وقواعد التعامل مع مفتاح الإنتاج.
• عروض الأسعارنقطة نهاية عرض السعر، وتفصيل الرسوم سطرًا بسطر، وكيف تعود حدود التحويل في الاستجابة، ومدة بقاء السعر مقفلاً بمجرد إنشاء أمر.
• الأوامرإنشاء أمر، مفتاح عدم التكرار، عنوان الإيداع، مذكرة إلزامية على بعض الشبكات، وقراءة انتقالات الحالة.
• البيانات المرجعيةكتالوجات التحويل والأصول والبلدان، ومخطط حقل المستفيد الذي يتيح لك إنشاء نموذج الدفع الخاص بك، وترقيم المؤشر.
• الخطافاتالأحداث المُرسلة، توقيع HMAC-SHA256 على الجسم الخام، نافذة إعادة الإرسال، جدول إعادة المحاولة، ولماذا يجب أن يتم التحقق في وقت ثابت.
• الأخطاءكل رمز خطأ مع حالة HTTP الخاصة به، وما يعنيه بالضبط، وما يجب فعله حياله على جانب التكامل، وأيها يستحق إعادة المحاولة.

• لا مدفوعات لأطراف ثالثة. يجب أن يتطابق اسم المستفيد مع الهوية الموثقة لصاحب الطلب، وتتحقق قنوات الدفع الآن من الاسم مقابل الحساب.
• لا إنشاء حساب أو التحقق من الهوية عبر واجهة البرمجة. تلك الخطوات تحدث في تدفق يرى فيه المستخدم ما يقبله.
• لا مفتاح في معامل عنوان URL. عناوين URL تنتهي في السجلات وترويسات المُحيل والسجلات التاريخية: المفتاح الذي يُمرر بهذه الطريقة هو مفتاح يجب إبطاله.
• لا تخزين مؤقت لعرض السعر من جانبنا. الاستجابة تحمل Cache-Control: no-store، ويجب ألا يلتف تكاملك حولها: عرض السعر المخزن مؤقتًا هو سعر قديم يُقدم على أنه ثابت.
• لا نقطة نهاية لشراء العملات المشفرة. الخدمة تعمل في اتجاه واحد، من الأصول الرقمية إلى العملة القانونية.