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

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

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

المصادقة

بيانات الاعتماد وقدرات الرموز ومتطلبات الوصول.

تستخدم REST API V1 وتكاملات Gateway رموز وصول شخصية يملكها مستخدم مخوّل في TLGPS. امتلاك الرمز جزء واحد فقط من التحقق من الوصول.

بيانات اعتماد REST

أرسل الرمز في ترويسة المصادقة مع كل طلب محمي:

Authorization: Bearer <token>
Accept: application/json

لا يتطلب مسار فحص حيوية API العام بيانات اعتماد. أما مسارات موارد الأسطول فتتطلب مصادقة صحيحة، وشركة نشطة يتوفر لها REST API، والصلاحية الفعلية لصاحب الرمز، وقدرة الرمز المقابلة.

قدرات رموز الوصول

العملية القدرة المطلوبة
GET /v1/companies companies.view-any
GET /v1/companies/{company} companies.view
GET /v1/vehicles vehicles.view-any
GET /v1/vehicles/{vehicle} vehicles.view
GET /v1/vehicles/{vehicle}/history vehicles.history
الاشتراك في مركبة عبر Gateway telemetry.subscribe

تقيّد القدرات بيانات الاعتماد. ولا تمنح صاحب الرمز صلاحيات تطبيق إضافية أو نطاق رؤية أوسع للموارد.

بيانات اعتماد Gateway

ترسل أنظمة التكامل رسالة authenticate بعد فتح اتصال WebSocket على العنوان المهيأ:

{
    "type": "authenticate",
    "data": { "token": "<token>" }
}

انتظر authenticated قبل إرسال الاشتراكات. يحتاج صاحب الرمز إلى إتاحة Gateway، والصلاحية الفعلية telemetry.subscribe، والوصول إلى المركبة، وقدرة الرمز المقابلة. تستخدم البوابة اعتماد متصفح منفصلًا؛ وهو ليس واجهة عامة لإصدار الرموز.

التعامل مع بيانات الاعتماد

استخدم HTTPS وWSS في التكاملات المنشورة. لا تنشر الأسرار في الأمثلة أو عناوين URL أو تطبيقات المتصفح. لا تتيح الرموز المنتهية أو الملغاة إقامة وصول مصرّح به. تخضع اتصالات Gateway القائمة لإعادة تحقق دورية، وقد تُغلق عند تغير الوصول.

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

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

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