52 lines
4.0 KiB
Markdown
52 lines
4.0 KiB
Markdown
# API reference — AlterFlixHub
|
|
|
|
ทุก endpoint เป็น `JSON` และอยู่ใต้ path `/api` ของแอปเอง (ไม่ต้องมี prefix อื่น)
|
|
ค่าเริ่มต้น: `Content-Type: application/json` · error ใช้รูปแบบ `{ statusMessage }` หรือ `{ message }`
|
|
|
|
## สาธารณะ (ไม่ต้องล็อกอิน)
|
|
|
|
| Method | Path | Body / Query | ทำอะไร |
|
|
|---|---|---|---|
|
|
| POST | `/api/analytics/collect` | `{ type, locale, query?, category?, result_count?, slug?, source?, position? }` | รับ event สถิติ 1 ครั้ง — เซิร์ฟเวอร์เป็นผู้ใส่ `at` และ hash ผู้เข้าชม (`sha256(เกลือรายวัน \| ip \| ua)` 16 ตัวอักษร) ไม่ใช้คุกกี้ ไม่เก็บ IP/UA ดิบ |
|
|
|
|
`type` ที่รองรับ: `search` · `cinema_select` · `cinema_view` · `near_me`
|
|
|
|
## หลังบ้าน (ต้องมีคุกกี้ `afx_admin`)
|
|
|
|
| Method | Path | Body / Query | ทำอะไร |
|
|
|---|---|---|---|
|
|
| POST | `/api/admin/login` | `{ username, password }` | ตรวจรหัส → ออกคุกกี้ HttpOnly เซ็น HMAC (8 ชั่วโมง) |
|
|
| POST | `/api/admin/logout` | — | ลบคุกกี้ session |
|
|
| GET | `/api/admin/session` | — | ตรวจว่ายังล็อกอินอยู่ |
|
|
| GET | `/api/admin/content` | — | อ่าน `ContentStore` ทั้งก้อน (`cinemas`, `site`, `about`) |
|
|
| PUT | `/api/admin/content` | `{ cinemas?, site?, about? }` | บันทึกเฉพาะส่วนที่ส่งมา — ผ่าน `sanitizeCinemas` / `sanitizeSite` / `sanitizeAbout` แล้วเขียนไฟล์แบบ atomic |
|
|
| POST | `/api/admin/cinemas/import` | `{ cinemas: Cinema[] }` หรือรายการเดียว | นำเข้าโรงหนังโดยใช้ slug เป็นกุญแจ (มีอยู่ = ทับ) |
|
|
| GET | `/api/admin/analytics` | `?days=1\|7\|30\|90` | สรุปสถิติ (`summarize()`) — คำค้นยอดนิยม, คำค้นไม่พบผล, CTR, โรงที่ถูกเปิด/คลิก |
|
|
|
|
## ข้อมูลที่ฝังมากับ loader (ไม่ใช่ API)
|
|
|
|
| Route | ค่าที่ส่งมา |
|
|
|---|---|
|
|
| `/` (root loader) | `content` (cinemas/site/about) + `localeFromUrl` |
|
|
| `/` (`_index` loader) | `popularity` (สถานะ/อันดับ "ยอดนิยม" จาก `computePopularity()`, memo 5 นาที) + `orderKey` (วันที่ UTC ใช้สลับลำดับการ์ดรายวันผ่าน `dailyOrder()`) |
|
|
|
|
## ตัวอย่างเรียก
|
|
|
|
```bash
|
|
# บันทึกเฉพาะ cinemas (เช่น หลังลากสลับลำดับ)
|
|
curl -X PUT http://localhost:8080/api/admin/content \
|
|
-H 'Content-Type: application/json' \
|
|
--cookie "$(cat .output/afx_admin.cookie)" \
|
|
-d '{"cinemas": [...]}'
|
|
|
|
# อ่านสถิติ 30 วัน
|
|
curl -H "Cookie: afx_admin=$TOKEN" \
|
|
'http://localhost:8080/api/admin/analytics?days=30'
|
|
```
|
|
|
|
## ข้อควรระวัง
|
|
|
|
- `PUT /api/admin/content` **เขียนทับทั้งก้อนของส่วนที่ส่งมา** — ถ้าส่ง `cinemas` ต้องส่งของครบทุกรายการ ไม่ใช่แค่ตัวที่แก้
|
|
- `slug` เปลี่ยนแล้วลิงก์เดิม `/cinema/<slug>` จะ 404 (ยังไม่มี redirect table)
|
|
- ไฟล์จริงอยู่ที่ `data/content/content.json` · สถิติที่ `data/analytics/events.jsonl` — ทั้งคู่ไม่ควรถูกเขียนด้วยมือระหว่างเซิร์ฟเวอร์รัน
|