帳號授權
開始掃碼認證
為 auth_mode=qrcode 的渠道啟動掃碼登入。可輪詢 /auth 或呼叫 /auth/qr/check 取得 QR 內容；部分 provider 的 QR 是透過 webhook 非同步推送，不會同步在回應主體中回傳。
https://api.unifyport.ai/v1/accounts/{account_id}/auth/qr/start支援渠道
呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。
參數從哪裡取得
- account_id
- 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 取得帳號
請求參數
請求標頭
X-Api-Key工作區 API Key，工作區會由此標頭解析得到。
Content-Type傳送 JSON 請求內容時請使用 application/json。
路徑參數
account_id用於該 authentication 路由的識別字。
請求內容
此介面接收空 JSON 物件；請依請求範例傳送 {}。
如何理解結果
依本次授權動作讀取 status/auth_status 和實際回傳的 auth_payload。需要使用者操作時依管道指南繼續；authorized 表示授權完成，傳送前仍須檢查 runtime_status。
回應 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"account_id": "acc_example",
"status": "awaiting_qr_scan",
"auth_payload": {
"qr_code": "https://example.com/qr"
},
"expires_at": "2026-01-01T00:00:00Z"
}
}
回應內容
account_id本回應所對應的渠道帳號。
provider管道識別碼。呼叫其他介面時原樣使用 API 回傳的值；此介面的回傳範圍請看下方列舉。
action本次請求的操作。
status目前授權流程狀態，例如 pending_auth、awaiting_qr_scan、awaiting_code、pending、passkey_required、passkey_pending、passkey_confirmation、passkey_confirmation_sent、authorized 或 failed。
auth_status目前的標準認證狀態，例如 awaiting_qr_scan、awaiting_code、passkey_required、authorized 或 failed。依據此值繼續對應渠道的授權流程。
auth_payload目前步驟所需的標準載荷。普通 QR 使用 qr_code；驗證碼步驟使用 type=code；Passkey 使用 type=passkey 與 public_key。互斥步驟的載荷不會同時出現。
expires_atRFC3339 時間戳記，超過後當前的 auth_payload 即失效。
回應
200200 OK
請求成功，回應內容範例如上。
400請求錯誤
請求內容、路徑或參數無效。
401未授權
X-Api-Key 請求標頭缺少或無效。
409衝突
目前操作與既有的渠道帳號或資源衝突。
500伺服器錯誤
服務遇到了未預期的錯誤。
502上游閘道錯誤
渠道轉接器或上游渠道未能完成此操作。
失敗後如何處理
檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。 錯誤碼參考
- invalid_request · 10000 · 400
- 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
- missing_api_key · 11000 · 401
- 檢查 X-Api-Key 與工作區是否有效。
- invalid_api_key · 11001 · 401
- 檢查 X-Api-Key 與工作區是否有效。
- account_already_authorized · 20016 · 409
- 帳號已授權，請重複使用；確需重新授權時先取消目前授權。