API 參考
API 認證
如何建立 API 金鑰並在請求中使用
NaraForm 提供 API 金鑰（API Key） 認證，讓你以程式方式存取所有表單操作。
建立 API 金鑰
- 進入 Dashboard → 設定（Settings）
- 找到「API 金鑰」區塊
- 點擊「建立金鑰」
- 輸入金鑰名稱（例如
Claude Code）並選擇權限範圍 - 複製顯示的金鑰字串 — 此金鑰只會顯示一次
金鑰格式
API 金鑰以 nf_ 開頭，例如：
nf_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4在請求中使用
在每個 API 請求的 Authorization header 帶入金鑰：
Authorization: Bearer nf_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4權限範圍（Scope）
| Scope | 說明 |
|---|---|
read | 列出表單、讀取回覆與分析資料 |
write | 包含 read 的所有權限，以及建立/更新/發布/刪除表單 |
建議依據用途選擇最小必要的 scope。唯讀的資料分析工具只需 read；需要建立或修改表單的 AI 工具才需要 write。
安全建議
- 不要將 API 金鑰存入版本控制（git）
- 不同用途建立不同金鑰，方便個別撤銷
- 定期檢視「最後使用時間」，撤銷不再使用的金鑰
- 金鑰洩露時立即在 Dashboard 撤銷