Octane

البداية السريعة

احصل على مفتاح API من أوكتين، ونفّذ أول طلب إلى نقطة نهاية المعاملات، واستقبل أول webhook خلال نحو خمس دقائق.

تحتاج إلى ثلاثة أشياء من أوكتين قبل أول استدعاء: تفعيل تكامل الواجهة على حسابك، وتسجيل عناوين IP الصادرة لديك، ومفتاح API. بعد ذلك يعيد طلب GET واحد معاملاتك، وإذا حددت عنوان webhook تصل المعاملات الجديدة من تلقاء نفسها.

فعّل التكامل

اطلب من مدير حسابك في أوكتين تفعيل تكامل الواجهة على حسابك. يتطلب الوصول أن يكون التكامل مفعّلًا على الحساب وأن يكون لديك ملف تسعير (charging profile) نشط لدى أوكتين.

أرسل عناوين IP الخاصة بك

لا تقبل مفاتيح الإنتاج الطلبات إلا من قائمة عناوين IP أو نطاقات CIDR تقدمها أنت. أرسل عناوين IP العامة الصادرة للأنظمة التي ستستدعي الواجهة. تُطبَّق القائمة من جانب أوكتين قبل تفعيل مفتاحك، فتُرفض الطلبات من العناوين الأخرى بالرمز 403 IP_NOT_ALLOWED.

اختياريًا، قدّم عنوان webhook بروتوكول HTTPS إذا أردت أن ترسل أوكتين المعاملات الجديدة إليك.

استلم مفتاح API

تنشئ أوكتين المفتاح وتشاركه معك مرة واحدة، ومعه سر الويب هوك إذا حددت عنوان webhook. لا تُعرض القيمتان مرة أخرى، فاحفظهما فورًا في مدير أسرار.

يبدو المفتاح هكذا:

oct_live_a1b2c3d4_Gk7fP2xQ9vLm3nRt8wYb5cHj6sDz1eAu4iFo0pNq

البادئة oct_live_ تعني مفتاح إنتاج. المقطع a1b2c3d4 هو بادئة المفتاح غير السرية التي تستخدمها أوكتين للإشارة إلى مفتاحك في محادثات الدعم. الباقي هو السر.

نفّذ أول طلب

اجلب المعاملات المؤكدة ليوم أمس:

curl "https://prod-app.octanetech-api.com/api/v1/integration/transactions?from=2026-09-20T00:00:00Z&to=2026-09-21T00:00:00Z&limit=50" \
  -H "X-API-Key: $OCTANE_API_KEY"

تبدو الاستجابة الناجحة هكذا (مختصرة):

{
  "data": [
    {
      "id": 185432,
      "status": "CONFIRMED",
      "created_at": "2026-09-20T08:59:36.340Z",
      "confirmed_at": "2026-09-20T09:00:02.110Z",
      "corporate": { "id": 67, "name": "Acme Logistics" },
      "fuel": { "type": { "id": 2, "name": "Benzine 92" }, "liters": 18.5, "price_per_liter": 13.75, "amount": 254.38 },
      "fees": { "total_amount": 255.435000 }
    }
  ],
  "pagination": { "limit": 50, "has_more": false, "next_cursor": null }
}

راجع نقطة نهاية المعاملات لكل الحقول.

استقبل أول webhook (اختياري)

إذا قدّمت عنوان webhook، يمكن لأوكتين إرسال حدث webhook.test عند الطلب لتتحقق من الاتصال ومن التحقق من التوقيع قبل وصول الحركة الحقيقية. اطلب من مدير حسابك تشغيله.

ينبغي لنقطة النهاية لديك أن:

  1. تقرأ جسم الطلب الخام (قبل تحليل JSON).
  2. تتحقق من ترويسة X-Octane-Signature بسر الويب هوك الخاص بك. راجع التحقق من التوقيع.
  3. ترد بأي حالة 2xx خلال 500 ملّي ثانية. أكّد الاستلام أولًا ثم عالج الحدث.

لا تُرسل سوى المعاملات المنشأة بعد ضبط عنوان الويب هوك، فاستخدم واجهة السحب لجلب ما قبل ذلك.

قائمة الإعداد

  • تكامل الواجهة مفعّل على حسابك في أوكتين
  • ملف تسعير نشط
  • عناوين IP الصادرة مُرسلة إلى أوكتين
  • مفتاح API محفوظ في مدير أسرار
  • عنوان الويب هوك (HTTPS على المنفذ 443، متاح علنًا) والسر محفوظان، إن كنت تستخدم الويب هوك
  • إعادة المحاولة مع تراجع تدريجي عند 429، وترقيم الصفحات بالمؤشر مُنفَّذ

في هذه الصفحة