API Reference

เรียก API

ใช้ base URL https://api.furipay.me/v1 โดย app API ที่มีการป้องกันด้านล่างต้องส่ง access token เป็น Bearer token ยกเว้น token endpoint

Authorization: Bearer YOUR_ACCESS_TOKEN

Rate limits

Rate limit นับแยกตามแอปและครีเอเตอร์:

เมื่อเกินกำหนด API จะตอบ 429 พร้อม header Retry-After

บัญชีและโปรไฟล์

GET /me ใช้ตรวจสอบตัวตนของครีเอเตอร์จาก token และไม่ต้องขอ scope เพิ่ม

curl -X GET \
  'https://api.furipay.me/v1/me' \
  -H 'Authorization: Bearer <token>'

GET /profile คืนโปรไฟล์สาธารณะ โซเชียล และข้อมูลช่องทางรับทิปพร้อมสถานะ enabled ต้องมี scope profile.read

curl -X GET \
  'https://api.furipay.me/v1/profile' \
  -H 'Authorization: Bearer <token>'

ทิป

GET /tips ต้องมี scope tips.read รองรับ limit 1–100 (ค่าเริ่มต้น 50), cursor, from และ to โดยวันที่ใช้รูปแบบ ISO 8601

curl -X GET \
  'https://api.furipay.me/v1/tips' \
  -H 'Authorization: Bearer <token>'

GET /tips/stats คืนยอดและจำนวนทิปทั้งหมดกับเดือนปัจจุบัน หน่วยเงินเป็น THB

curl -X GET \
  'https://api.furipay.me/v1/tips/stats' \
  -H 'Authorization: Bearer <token>'

POST /tips ต้องมี scope tips.create และรับ amount ที่เป็นบวกไม่เกินเพดานของระบบ, name 2–25 ตัวอักษรโดยใช้ A–Z, 0–9, ขีดล่างหรือเว้นวรรค และ message ไม่เกิน 255 ตัวอักษร ตัวตนครีเอเตอร์มาจาก token เสมอ

{
  "amount": 100,
  "name": "Nong",
  "message": "GG!"
}

Endpoint นี้บันทึกรายการทิปสำเร็จและส่ง event ไปยัง overlay แต่ไม่ได้เรียกเก็บเงินจากผู้สนับสนุน ให้เรียกหลังระบบต้นทางยืนยันการชำระเงินแล้วเท่านั้น

curl -X POST \
  'https://api.furipay.me/v1/tips' \
  -H 'Authorization: Bearer <token>'

Overlay และ event

POST /alerts ต้องมี scope alerts.create ใช้ส่ง alert ทดสอบไปยัง overlay โดยไม่สร้างประวัติทิป

curl -X POST \
  'https://api.furipay.me/v1/alerts' \
  -H 'Authorization: Bearer <token>'

GET /socket/token ต้องมี scope events.subscribe และคืน token อายุสั้น 10 นาทีสำหรับ socket

curl -X GET \
  'https://api.furipay.me/v1/socket/token' \
  -H 'Authorization: Bearer <token>'

Error responses

Protected endpoints ตอบ error ในรูปแบบเดียวกัน:

{
  "error": {
    "code": "insufficient_scope",
    "message": "This endpoint requires scope: tips.read"
  }
}

• 401 token ไม่มี ไม่ถูกต้อง หรือหมดอายุ
• 403 grant ใช้งานไม่ได้หรือ scope ไม่พอ
• 422 request ไม่ผ่าน validation
• 429 เกิน rate limit
• 502 ระบบต้นทางขัดข้อง