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

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

REST API / V1

الشركات

موارد REST API V1 والمصادقة وقراءات ضمن حدود الوصول.

تمثل الشركة جهة تملك أو تدير أسطولًا. لا تُعاد إلا الشركات الظاهرة للمستخدم الموثّق.

حقول الشركة

الحقل النوع المعنى
uuid UUID مُعرّف الشركة
name string اسم الشركة
vehicles_count integer عدد المركبات المرتبطة بالشركة
{
    "uuid": "01900000-0000-7000-8000-000000000002",
    "name": "Northstar Fleet Operations",
    "vehicles_count": 82
}

قائمة الشركات

GET https://api.tlgps.athear.ly/v1/companies
Authorization: Bearer <token>
Accept: application/json

يتطلب الطلب companies.view-any والصلاحية المقابلة. تُعاد مجموعة مقسمة إلى صفحات، ولا يدعم هذا المسار حاليًا مرشحات بحث. استخدم links وmeta للتنقل.

{
    "data": [
        {
            "uuid": "01900000-0000-7000-8000-000000000002",
            "name": "Northstar Fleet Operations",
            "vehicles_count": 82
        },
        {
            "uuid": "01900000-0000-7000-8000-000000000003",
            "name": "Example Fleet Company",
            "vehicles_count": 154
        }
    ],
    "links": {
        "first": "https://api.tlgps.athear.ly/v1/companies?page=1",
        "last": "https://api.tlgps.athear.ly/v1/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 15,
        "total": 2
    }
}

تفاصيل الشركة

GET https://api.tlgps.athear.ly/v1/companies/{company}
Authorization: Bearer <token>
Accept: application/json

استبدل بـ UUID لشركة ظاهرة. يتطلب الطلب companies.view والصلاحية المقابلة. حالات النتيجة الأساسية هي 200 و401 و403 و404.

{
    "data": {
        "uuid": "01900000-0000-7000-8000-000000000002",
        "name": "Northstar Fleet Operations",
        "vehicles_count": 82
    }
}

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

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

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