وصول برمجي إلى المركبات والمصروفات والتذكيرات وأعضاء الأسطول والنشاط. Base URL: https://api.aufix.app.
نظرة عامة
- All REST routes are under
/v1/…. - Successful responses use
{ "data": … }. - Errors use
{ "error": { "code": "…", "message": "…" } }. - Operational routes require an active Fleet plan (Fleet, Fleet Pro, or Fleet Max).
- Personal access tokens (PAT) are rate-limited; responses may include
Retry-After.
المصادقة
| HTTP | المورد | الوصف |
|---|
| — | Authorization: Bearer … | يتطلب كل مسار أدناه رمز وصول شخصي: Authorization: Bearer aufix_pat_…. أنشئ المفاتيح وألغِها من الإعدادات ← التكاملات (يظهر السر مرة واحدة فقط). read — GET فقط؛ write — جميع الطرق. |
المركبات
| HTTP | المورد | الوصف |
|---|
| GET | /v1/vehicles | عرض قائمة المركبات المتاحة. Query: limit، المؤشر after. |
| POST | /v1/vehicles | إنشاء مركبة في مرآبك. |
| GET | /v1/vehicles/:vehicleId | الحصول على مركبة واحدة. |
| PATCH | /v1/vehicles/:vehicleId | تحديث حقول المركبة. |
| DELETE | /v1/vehicles/:vehicleId | حذف مركبة والسجلات المرتبطة بها (المالك). |
تحديثات المركبة
| HTTP | المورد | الوصف |
|---|
| GET | /v1/vehicles/:vehicleId/updates | عرض قائمة تحديثات الحالة (عدد الكيلومترات، الوقود/الشحن، الحالة، الإطارات، التعليق). Query: limit، afterId + afterAt. |
| POST | /v1/vehicles/:vehicleId/updates | تسجيل تحديث جديد لمركبة. |
المصروفات
| HTTP | المورد | الوصف |
|---|
| GET | /v1/expenses | عرض قائمة المصروفات (الأحدث أولاً). Query: limit، vehicleId، المؤشر afterId + afterValue. |
| POST | /v1/expenses | إنشاء مصروف لمركبة أو مصروف شخصي بدون مركبة. |
| PATCH | /v1/expenses/:expenseId | تحديث مصروف. |
| DELETE | /v1/expenses/:expenseId | حذف مصروف. |
التذكيرات
| HTTP | المورد | الوصف |
|---|
| GET | /v1/reminders | عرض قائمة التذكيرات حسب تاريخ الاستحقاق. Query: limit، vehicleId، المؤشر afterId + afterValue. |
| POST | /v1/reminders | إنشاء تذكير لمركبة أو تذكير شخصي. |
| PATCH | /v1/reminders/:reminderId | تحديث حقول التذكير (بما في ذلك حالة الإنجاز حيثما كانت مدعومة). |
| DELETE | /v1/reminders/:reminderId | حذف تذكير. |
النشاط
| HTTP | المورد | الوصف |
|---|
| GET | /v1/activity | سجل نشاط مالك الأسطول. Query: limit، المؤشر afterId + afterAt. |
الأسطول
| HTTP | المورد | الوصف |
|---|
| GET | /v1/fleet/members | عرض أعضاء الأسطول وأدوارهم وتعيينات المركبات. |
| GET | /v1/fleet/invites | يعرض دعوات الأسطول. يعيد الحقول inviteId, email, role, status, acceptedBy, expiresAt, createdAt, updatedAt, isExpired. |