เอกสารอ้างอิงการยืนยันตัวตน API

สรุป

Elimapi รองรับการยืนยันตัวตนสองวิธี ทุกคำขอ API ต้องแนบข้อมูลการยืนยันตัวตนใน header

วิธีการ	Header	ใช้สำหรับ	การจัดการเซสชัน
โทเค็นการเข้าถึง (JWT)	`Authorization: Bearer <token>`	แอปที่มีอินเทอร์เฟซผู้ใช้	เข้าสู่ระบบเป็นระยะ โทเค็นมีอายุ
คีย์ API	`x-api-key: <key>`	การผสานรวมแบบ server-to-server	ไม่ต้องจัดการ เนื่องจากคีย์ผูกกับบัญชี

คู่มือทีละขั้นตอน: การยืนยันตัวตนคำขอ API

Endpoint	Method	คำอธิบาย	การยืนยันตัวตน
`/v1/auth/login`	POST	เข้าสู่ระบบด้วยอีเมล + รหัสผ่าน ส่งคืน `access_token` และ `refresh_token`	ไม่ต้อง
`/v1/auth/refresh`	POST	รีเฟรชโทเค็นการเข้าถึงด้วยรีเฟรชโทเค็น (header `authorization`)	ต้องใช้
`/v1/auth/change-password`	POST	เปลี่ยนรหัสผ่านสำหรับผู้ใช้ที่เข้าสู่ระบบอยู่	ต้องใช้
`/v1/me/plan-status`	GET	ดูสถานะแพ็กเกจ: ระยะเวลาการใช้งาน โควตาที่เหลือ ยอดเครดิตคงเหลือ	ต้องใช้

โครงสร้าง body ของคำขอเข้าสู่ระบบ:

{
  "email": "[email protected]",
  "password": "password"
}

โครงสร้าง response ของการเข้าสู่ระบบ: { user, access_token, expires_in, refresh_token } — expires_in คือ timestamp (ms) ที่โทเค็นหมดอายุ

แพ็กเกจสมัครสมาชิก (Subscription): หากแพ็กเกจ (Free, Individual, Team, Enterprise) หมดอายุ คำขอ API จะถูกปฏิเสธ
โควตาการใช้งาน (Usage Quota): ทุกคำขอที่สำเร็จจะถูกหักจากจำนวนรวมต่อเดือนของแพ็กเกจ
เครดิต (Credits): เมื่อใช้โควตาของแพ็กเกจหมด ระบบจะหักจากยอดเครดิตอัตโนมัติ (ถ้ามี)
การจำกัดอัตราการเรียกใช้: ข้อจำกัดความเร็วในการเรียก API เพื่อให้ระบบมีเสถียรภาพ

ตรวจสอบโควตาปัจจุบันผ่าน GET /v1/me/plan-status หรือบนแดชบอร์ด

รหัสข้อผิดพลาด	ความหมาย	วิธีจัดการ
401 Unauthorized	โทเค็นหรือคีย์ API ขาดหาย ผิด หรือหมดอายุ	ตรวจสอบ header `Authorization` หรือ `x-api-key` อีกครั้ง
403 Forbidden	บัญชีถูกระงับหรือไม่มีสิทธิ์เพียงพอ	ตรวจสอบสถานะบัญชีบนแดชบอร์ด
429 Too Many Requests	เกินการจำกัดอัตราการเรียกใช้	ลดความถี่ในการเรียกหรืออัปเกรดแพ็กเกจ
400 Bad Request	ใช้โควตาหมดและไม่มีเครดิตเหลือ	อัปเกรดแพ็กเกจหรือซื้อเครดิตเพิ่ม