คีย์ API

สร้างคีย์ API

POST /api/v1/api-keys

สร้างคีย์ API ใหม่สำหรับผู้ใช้ที่ได้รับการรับรองความถูกต้อง

เนื้อหาคำขอ

{
  "name": "My integration"
}

ฟิลด์	จำเป็น	คำอธิบาย
name	ใช่	ชื่อที่แสดงสำหรับคีย์ (1–100 ตัวอักษร)

การตอบสนอง

{
  "data": {
    "id": "key_uuid",
    "name": "My integration",
    "prefix": "rm_abc123",
    "key": "rm_abc123def456...",
    "created_at": "2025-09-19T15:00:00.000Z"
  }
}

คำเตือน

ฟิลด์ key จะถูกส่งคืน เพียงครั้งเดียว ในขณะที่สร้างเท่านั้น จัดเก็บอย่างปลอดภัย. ไม่สามารถเรียกคืนอีกครั้งได้ เฉพาะ prefix (8 ตัวอักษรแรก) เท่านั้นที่จะแสดงในคำขอที่ตามมา

---

แสดงรายการคีย์ API

GET /api/v1/api-keys

ส่งคืนคีย์ API ทั้งหมดสำหรับผู้ใช้ที่ได้รับการรับรองความถูกต้อง ค่าคีย์แบบเต็มจะไม่ถูกส่งคืนหลังจากสร้างแล้ว

การตอบสนอง

{
  "data": [
    {
      "id": "key_uuid",
      "name": "My integration",
      "prefix": "rm_abc123",
      "created_at": "2025-09-19T15:00:00.000Z",
      "last_used_at": "2025-09-20T10:30:00.000Z",
      "is_revoked": false
    }
  ]
}

---

เพิกถอนคีย์ API

DELETE /api/v1/api-keys/:id

เพิกถอนคีย์ API อย่างถาวร คำขอที่ใช้คีย์นี้จะล้มเหลวทันทีด้วย INVALID_API_KEY

การตอบสนอง

{
  "data": { "success": true }
}

รหัสข้อผิดพลาด

รหัส	สถานะ HTTP	ความหมาย
API_KEY_NOT_FOUND	404	คีย์ไม่มีอยู่หรือเป็นของผู้ใช้อื่น
ALREADY_REVOKED	400	คีย์ถูกเพิกถอนไปแล้ว