快速入門

取得 API 金鑰

1. 建立個人金鑰

在 Sofia 應用程式中開啟設定 › API,進入個人存取分頁並建立金鑰。選擇它的名稱、有效期限和權限。金鑰只會顯示一次:請複製並存放在機密管理工具中,切勿寫進程式碼。

2. 發出第一次呼叫

在 Authorization 標頭中傳送金鑰。GET /v1/me 會告訴你金鑰代表誰操作,以及它的 Workspace 和權限。

bash
curl https://api.sofia-post.com/api/v1/me \
  -H "Authorization: Bearer $SOFIA_API_KEY"
json
{
  "tokenType": "personal_key",
  "user": { "id": "cmo7qiltc0000sb1p7zdx1aw4" },
  "coverage": "account",
  "workspaces": [{ "id": "cmo7qiltc0000sb1p7zdx1aw4", "name": "160 food" }],
  "scopes": ["establishments:read", "posts:read", "posts:write"],
  "mode": "live",
  "expiresAt": "2026-11-09T20:09:05.644Z"
}

3. 列出你的門市

每則貼文都屬於一家門市。記下你要發布的那家門市的 id。

bash
curl https://api.sofia-post.com/api/v1/establishments \
  -H "Authorization: Bearer $SOFIA_API_KEY"

下一步

現在可以發布你的第一則貼文了。想在瀏覽器中試用任何端點,請開啟 API 參考並點選試用。