توثيق المطورين
بدء الاستخدام
تجهيز الوصول المصرّح به وتنفيذ أول طلب قراءة.
ابدأ بطلب قراءة مصرّح به قبل إضافة اتصال طويل العمر عبر Gateway.
1. تأكيد الوصول
نسّق للحصول على حساب نشط ضمن شركة في TLGPS من خلال جهة الاتصال المخوّلة في شركتك. تأكد من إتاحة REST API أو Gateway للشركة ومن امتلاك حسابك الصلاحيات الفعلية المناسبة. توفير الوصول إجراء مضبوط؛ هذا التوثيق لا ينشئه تلقائيًا.
2. تجهيز بيانات الاعتماد
إذا كان حسابك مخوّلًا بإصدار رموز الوصول الشخصية، فاستخدم صفحة رموز API في البوابة لإصدار رمز بالقدرات المطلوبة وتاريخ انتهاء مناسب. وإلا فتواصل مع مسؤول مخوّل. لا يمكن للرمز منح صلاحيات أو قدرات شركة لا يملكها صاحبه.
احتفظ بالرمز في خادم موثوق. لا تضع رمز وصول شخصيًا في حزمة شيفرة متصفح عامة، أو عنوان URL، أو مستودع، أو لقطة شاشة. احفظ السر الصادر بأمان واستخدم قيمة بديلة واضحة في الأمثلة المشتركة.
3. قراءة المركبات الظاهرة
استخدم عنوان API العام المخصص لبيئتك:
GET https://api.tlgps.athear.ly/v1/vehicles Authorization: Bearer <token> Accept: application/json
يتطلب الطلب قدرة الرمز vehicles.view-any والصلاحية الفعلية المقابلة. تتضمن الاستجابة المركبات التي يسمح نطاقك برؤيتها فقط. قد تكون المجموعة الفارغة نتيجة صحيحة؛ نجاح المصادقة لا يمنح الوصول إلى جميع المركبات.
4. استخدام مُعرّف من الاستجابة
استخدم UUID لمركبة وردت في استجابة مصرّح بها لقراءة تفاصيل المركبة أو سجلها. لكل عملية قدرة رمز وصلاحيات خاصة بها. يتطلب السجل أيضًا معاملي الاستعلام from وto.
5. المتابعة مع Gateway
لتلقي تحديثات المركبات المدعومة، راجع الاتصال والمصادقة، ثم اشتراكات المركبات. انتظر نجاح المصادقة قبل الاشتراك. لا تُرسل الحالة الأولية إلا إذا توفرت. تعامل مع انقطاع الاتصال وأعد إنشاء الاشتراكات عند إقامة اتصال موثّق جديد.