預約示範免費註冊註冊登入

REST API

在您的 Skimle 專案上進行開發

用於讀寫專案資料、以及從頭到尾執行專案的 JSON 端點。以 Bearer 金鑰驗證身分、送出一個動作，即可取得 JSON 回應。

三個步驟開始使用

從零開始，到完成第一個通過驗證的呼叫。

1

建立 API 金鑰

專案金鑰可存取單一專案。帳戶金鑰可存取單一團隊，並能在其中建立專案。兩者都有讀取與編輯兩種等級。

  1. 1. 開啟 API 金鑰頁面
  2. 2. 選擇金鑰要存取的專案，並設定讀取或編輯權限
  3. 3. 複製金鑰：Skimle 只會保存它的雜湊值

請立即複製金鑰。

完整的金鑰值只會在建立時顯示一次。關閉對話框後，我們這邊只保留雜湊值，遺失的金鑰必須重新發行。

2

送出第一個請求

將金鑰作為 Bearer 權杖傳送，動作則放在 JSON 本文中。每個端點都接收 JSON 並回傳 JSON。

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

讀取金鑰以 r 結尾，編輯金鑰以 e 結尾。專案金鑰呼叫 /api/skimle-read 與 /api/skimle-write。帳戶金鑰呼叫 /api/skimle-account。

3

開啟 API 參考文件

瀏覽所有端點的說明、請求格式與試用面板。每條路由都接受以 action 欄位區分的聯合型別本文。

開啟參考文件讀取端點 →寫入端點 →專案端點 →

原始的 OpenAPI 3.1 規格位於 /api/openapi.json.

準備好開始開發了嗎？

管理您的專案金鑰，或了解供 AI 代理用戶端使用的 MCP 伺服器。

建立 API 金鑰改用 MCP