انتقل إلى المحتوى
TLGPSالتوثيق

توثيق المطورين

Gateway / V1

الاشتراكات

اتصالات Gateway V1 واشتراكات المركبات والتحديثات المدعومة.

موضوع الاشتراك المدعوم في هذا الإصدار هو vehicle فقط. تُرفض المواضيع الأخرى. يتكون الاشتراك من topic وidentifier، حيث المُعرّف هو UUID المركبة نفسه المستخدم في REST.

طلب الاشتراك

أرسل مصفوفة غير فارغة باسم subscriptions في المستوى الأعلى للرسالة، بعد نجاح المصادقة:

{
    "type": "subscribe",
    "subscriptions": [
        {
            "topic": "vehicle",
            "identifier": "01900000-0000-7000-8000-000000000001"
        }
    ]
}

يمكن أن تحتوي الدفعة على عدة مركبات. تُدمج الأزواج المكررة من الموضوع والمُعرّف في اشتراك فعلي واحد. إذا كانت أي مركبة غير متاحة فلا يُسجّل أي اشتراك من تلك الدفعة، دون كشف ما إذا كانت المركبة غير موجودة أو غير مصرّح بها.

إقرار الاشتراك

يُعاد إقرار لكل اشتراك مقبول:

{
    "type": "subscribed",
    "timestamp": "2026-07-05T15:37:10+02:00",
    "data": {
        "subscription": {
            "topic": "vehicle",
            "identifier": "01900000-0000-7000-8000-000000000001"
        }
    }
}

ملاحظة

يمكن الاشتراك في مركبة غير متصلة.

وإذا لم تتوفر حالة محلولة للمركبة، يصل subscribed دون رسالة telemetry أولية. يظل الاشتراك فعالًا لاستقبال تحديثات لاحقة إذا توفرت.

إلغاء الاشتراك

{
    "type": "unsubscribe",
    "subscriptions": [
        {
            "topic": "vehicle",
            "identifier": "01900000-0000-7000-8000-000000000001"
        }
    ]
}

إقرار الإلغاء:

{
    "type": "unsubscribed",
    "timestamp": "2026-07-05T15:37:10+02:00",
    "data": {
        "subscription": {
            "topic": "vehicle",
            "identifier": "01900000-0000-7000-8000-000000000001"
        }
    }
}

إلغاء اشتراك غير مسجل لا يغيّر الاشتراكات الأخرى. ترتبط الاشتراكات بالاتصال الحالي وتنتهي بإغلاقه. لا يُعد إقرار الاشتراك ضمانًا لوصول حالة أولية أو تدفق بلا انقطاع.

توثيق عام · يتطلب التكامل وصولًا مصرّحًا به

توثيق تديره فرق الهندسة. تستخدم الأمثلة بيانات توضيحية وقيَمًا بديلة لبيانات الاعتماد.

العودة إلى الأعلى