API 參考 (API Reference)

瑞成 PMS 透過 Next.js Route Handlers 暴露 HTTP 端點，並以 Server Actions 處理伺服器端邏輯。

這是單一 Next.js 16 app — 沒有獨立的 API server。大多數讀寫由 Server Component fetch 與 Server Actions 完成；Route Handler 只用於 health、auth 與 OpenAPI 描述。

Base URL

所有 Route Handler 端點都相對於你部署後的 Next.js app URL。在下方 playground 設定 base URL。

Endpoints

Health

Method	Path	說明
GET	/api/health	Health check — 回傳 { status: "ok" }

OpenAPI

Method	Path	說明
GET	/api/openapi	回傳 OpenAPI 描述文件

Auth（Auth.js v5，工牌登入）

Method	Path	說明
GET	/api/auth/session	取得目前 session
POST	/api/auth/signin	以工牌編號 + 密碼登入
POST	/api/auth/signout	登出
GET	/api/auth/csrf	表單用 CSRF token

瑞成 PMS 沒有 OAuth callback、沒有金流 webhook（billing 功能已從產品移除）。

Interactive Playground

設定你部署後的 Next.js app URL，即可發送真實 HTTP 請求：

GET/api/healthGET /api/healthGET /api/auth/sessionPOST /api/auth/signin

Base URL (your deployed Next.js app)

Authorization Header (optional)

Try in Live App →

Server Actions

Server Actions 無法跨來源呼叫，由 React 元件在伺服器端直接 invoke。完整清單見 Server Actions。

Authentication

大多數端點需要有效的 Auth.js session。session cookie 在工牌登入後自動設定。

1. 以 POST /api/auth/signin 帶 { badge, password } 登入取得 session cookie
2. 以 GET /api/auth/session 檢視目前 session
3. 後續同來源請求會自動帶上 session cookie

注意： 從本文件站發出的跨來源請求不會自動帶 session cookie。請在部署後的 app 同來源環境測試。