type: api_detail
status: draft
last_verified:
environment:
method:
host:
path:
這支 API 回答什麼
說明這支 API 的用途與前端使用情境。
出現位置
| 類型 | 文件 | 備註 |
|---|---|---|
| 頁面 | ../前端操作觀測/頁面/… | |
| 操作 | ../前端操作觀測/操作/… |
觸發方式
從前端哪個畫面、哪個按鈕或哪個表單觸發。
Request
Headers
| Header | 是否必要 | 備註 |
|---|---|---|
X-PRO360-Rest-Api-Key | 是 | 不記錄真實 secret 以外的敏感值 |
X-PRO360-User-Session-Token | 視情境 | 文件中遮蔽 |
Body
| 欄位 | 型別 | 是否必要 | 前端來源 | 備註 |
|---|---|---|---|---|
Response
Success
{}Error
{}前端如何使用 Response
Routing / Origin
- CloudFront behavior：
- ALB rule：
- origin marker：
- CORS owner：
DB / Side Effect
注意事項
- response shape 要以 legacy / 實測為準，不可自行新增欄位。
- 不要貼完整 session token、JWT、Cookie、驗證碼。