การยืนยันตัวตน (Authentication)
ทุกคำขอไปยัง REST API ต้องแนบ API key ผ่านส่วนหัว X-Api-Key
คีย์ผูกกับโรงแรม (property) ของคุณโดยอัตโนมัติ — คุณจึงไม่ต้องส่ง property id ในคำขอ
สร้างและจัดการคีย์
ไปที่ Settings → API Keys ในแผงควบคุมโรงแรม
- สร้างคีย์ — กด Create key ค่าคีย์เต็มจะแสดงเพียงครั้งเดียว คัดลอกเก็บไว้ให้ปลอดภัย
- หมุนเวียนคีย์ (rotate) — เมื่อสงสัยว่าคีย์รั่ว กด Rotate เพื่อออกค่าคีย์ใหม่และยกเลิกของเดิม
- เก็บคีย์ไว้ฝั่งเซิร์ฟเวอร์เสมอ อย่าฝังคีย์ในโค้ดฝั่งเบราว์เซอร์
ส่งคีย์ในคำขอ
curl "https://app.romnest.com/api/v1/partner/v1/me" \
-H "X-Api-Key: YOUR_API_KEY"
หากไม่ส่งส่วนหัวนี้ จะได้ 401 Unauthorized พร้อมข้อความ Missing X-Api-Key header.
สิทธิ์การเข้าถึง (scopes)
API มี 2 ระดับสิทธิ์
| Scope | ทำอะไรได้ | แพ็กที่ใช้ได้ |
|-------|-----------|--------------|
| read | ตรวจสอบห้องว่าง ดูข้อมูลห้อง/ราคา/การจอง | ทุกแพ็ก (รวมฟรี) |
| write | สร้าง/ยกเลิกการจอง | Starter ขึ้นไป |
หากเรียก endpoint แบบ write ด้วยคีย์ของแพ็กฟรี จะได้ 403 Forbidden พร้อมข้อความ
Write API requires the Starter plan or higher. — ดูรายละเอียดที่ รหัสข้อผิดพลาด