ابتدائی رسائی کی درخواست کریں

اپنا پہلا نام اور ای میل یا فون نمبر درج کریں۔ ہم Tajo تک رسائی کی تفصیلات کے ساتھ آپ سے رابطہ کریں گے۔

REST API اینڈ پوائنٹس

Caution

ڈیمو صفحہ - یہ ایک ڈیمو صفحہ ہے جو ملٹی ٹیب دستاویزات کی خصوصیت دکھاتا ہے۔ یہ مواد صرف وضاحت کے لیے ہے۔

ہمارا REST API ڈیٹا تک رسائی اور اس میں تبدیلی کے لیے اینڈ پوائنٹس فراہم کرتا ہے۔ تمام اینڈ پوائنٹس ڈیٹا JSON فارمیٹ میں واپس کرتے ہیں۔

بنیادی URL

تمام API درخواستیں اس بنیادی URL پر بھیجی جانی چاہئیں:

https://api.example.com/v1

یوزرز کے اینڈ پوائنٹس

تمام یوزرز حاصل کریں

GET /users

تمام یوزرز کی فہرست واپس کرتا ہے۔ pagination کے پیرامیٹرز کی سپورٹ موجود ہے۔

کوئری پیرامیٹرز:

پیرامیٹرقسمتفصیل
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
}
}

ID سے یوزر حاصل کریں

GET /users/{id}

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

تمام پروڈکٹس کی فہرست واپس کرتا ہے۔ فلٹرنگ اور pagination کی سپورٹ موجود ہے۔

کوئری پیرامیٹرز:

پیرامیٹرقسمتفصیل
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 معاون

السلام علیکم! دستاویزات کے بارے میں کچھ بھی پوچھیں۔