اطلب الوصول المبكر

أدخل اسمك الأول وبريدك الإلكتروني أو رقم هاتفك. سنتواصل معك لتزويدك بتفاصيل الوصول إلى Tajo.

نقاط نهاية REST API

Caution

صفحة عرض توضيحي - هذه صفحة عرض توضيحي تبرز ميزة التوثيق متعدد التبويبات. المحتوى هنا لأغراض التوضيح فقط.

يوفر REST API لدينا نقاط نهاية للوصول إلى البيانات والتعامل معها. تعيد جميع نقاط النهاية البيانات بصيغة JSON.

عنوان URL الأساسي

يجب توجيه جميع طلبات API إلى عنوان URL الأساسي التالي:

https://api.example.com/v1

نقاط نهاية المستخدمين

جلب جميع المستخدمين

GET /users

تعيد قائمة بجميع المستخدمين. تدعم معاملات ترقيم الصفحات.

معاملات الاستعلام:

المعاملالنوعالوصف
pageintegerرقم الصفحة (الافتراضي: 1)
limitintegerعدد السجلات في الصفحة (الافتراضي: 50، الحد الأقصى: 100)
sortstringالحقل الذي يُرتَّب حسبه (مثل “name” أو “created_at”)

الاستجابة:

{
"data": [
{
"id": "user_123",
"name": "John Doe",
"email": "[email protected]",
"created_at": "2023-01-15T08:30:00Z"
},
// More users...
],
"meta": {
"total": 250,
"page": 1,
"limit": 50
}
}

جلب مستخدم بالمعرّف

GET /users/{id}

تعيد مستخدمًا واحدًا بحسب المعرّف.

الاستجابة:

{
"data": {
"id": "user_123",
"name": "John Doe",
"email": "[email protected]",
"created_at": "2023-01-15T08:30:00Z",
"profile": {
"bio": "Software developer",
"location": "New York",
"avatar_url": "https://example.com/avatars/john.jpg"
}
}
}

نقاط نهاية المنتجات

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

GET /products

تعيد قائمة بجميع المنتجات. تدعم التصفية وترقيم الصفحات.

معاملات الاستعلام:

المعاملالنوعالوصف
categorystringتصفية حسب الفئة
min_pricenumberتصفية حسب الحد الأدنى للسعر
max_pricenumberتصفية حسب الحد الأقصى للسعر
pageintegerرقم الصفحة (الافتراضي: 1)
limitintegerعدد السجلات في الصفحة (الافتراضي: 50، الحد الأقصى: 100)

الاستجابة:

{
"data": [
{
"id": "prod_123",
"name": "Example Product",
"description": "This is an example product",
"price": 49.99,
"category": "electronics"
},
// More products...
],
"meta": {
"total": 350,
"page": 1,
"limit": 50
}
}

معالجة الأخطاء

تتبع جميع نقاط النهاية رموز حالة HTTP القياسية، وتتضمن رسائل خطأ مفصّلة عند الاقتضاء:

رمز الحالةالوصف
200OK، نجح الطلب
400Bad Request، معاملات غير صالحة
401Unauthorized، المصادقة مطلوبة
403Forbidden، الصلاحيات غير كافية
404Not Found، المورد غير موجود
429Too Many Requests، تم تجاوز حد المعدل
500Internal Server Error، حدث خطأ في الخادم

تتضمن استجابات الخطأ رسالة توضح سبب الخلل:

{
"error": {
"code": "invalid_parameter",
"message": "The parameter 'email' is not a valid email address",
"request_id": "req_abc123"
}
}

اطلب الوصول المبكر

أدخل اسمك الأول وبريدك الإلكتروني أو رقم هاتفك. سنتواصل معك لتزويدك بتفاصيل الوصول إلى Tajo.

اكتشاف تلقائي
مساعد AI

مرحباً! اسألني أي شيء عن الوثائق.