ขอสิทธิ์ใช้งานล่วงหน้า

กรอกชื่อพร้อมอีเมลหรือหมายเลขโทรศัพท์ แล้วเราจะติดต่อกลับพร้อมรายละเอียดการเข้าใช้งาน Tajo

เอนด์พอยต์ REST API

Caution

หน้าเดโม หน้านี้เป็นหน้าตัวอย่างเพื่อแสดงความสามารถของเอกสารแบบหลายแท็บ เนื้อหาทั้งหมดใช้เพื่อการสาธิตเท่านั้น

REST API ของเรามีเอนด์พอยต์สำหรับเข้าถึงและจัดการข้อมูล ทุกเอนด์พอยต์ส่งข้อมูลกลับมาในรูปแบบ JSON

Base URL

คำขอ API ทั้งหมดต้องส่งไปยัง base URL ต่อไปนี้

https://api.example.com/v1

เอนด์พอยต์ผู้ใช้

ดึงรายชื่อผู้ใช้ทั้งหมด

GET /users

คืนค่ารายชื่อผู้ใช้ทั้งหมด รองรับพารามิเตอร์สำหรับแบ่งหน้า

พารามิเตอร์ query:

พารามิเตอร์ชนิดคำอธิบาย
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

คืนค่ารายการสินค้าทั้งหมด รองรับการกรองและการแบ่งหน้า

พารามิเตอร์ query:

พารามิเตอร์ชนิดคำอธิบาย
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

สวัสดี! ถามฉันเกี่ยวกับเอกสารได้เลย