FREONE 基礎名詞

開始串接前，先了解 FREONE 的資料層級與存取身分。

資料層級

organization（組織）
└─ merchant（商家）
   └─ squad（組別／一本班表）

名詞	白話說明
organization	FREONE 最上層的組織範圍，用於管理同一公司或品牌旗下的多個商家。
merchant	FREONE 的「商家」，是實際營運單位，通常對應一間商店或一個據點。每個商家隸屬於一個 organization，並有自己的時區與組別；API 以 merchantId 指定商家。
squad	FREONE 的「組別」，是商家內一本班表的管理單位。每個組別可有自己的組員、崗位與時段設定；API 以 squadId 指定組別。

人員與排班用詞

名詞	FREONE 用詞
enrollment	組員。指商家內可被排入班表的人員，並會隸屬於組別。
manager	管理員。目前角色一律為 manager，由 organization、merchant 或 squad scope（授權範圍）決定可管理的資源。
identity tag	身份別。例如正職、兼職或自訂身份，可用於套用排班規則。
position	崗位。定義組別內排班時的工作位置，也可用於時段所需人數。

Service Account

Service Account 是「系統存取 FREONE API 的身分」，不是組員或管理員的登入帳號。FREONE 會為 Sandbox 與 Production 分別核發 API Key、API Secret 與權限。

申請時需說明要串接整個組織或指定商家。取得憑證後，可以透過 GET /v1/merchants 與 GET /v1/squads 確認該 Service Account 實際可存取的商家與組別。

Manager 帳號的管理範圍

Manager 是可登入 FREONE 後台的管理員帳號，與呼叫 API 的 Service Account 不同。Manager 的角色固定為 manager，scope 則決定可管理的範圍：organization scope 管理組織、merchant scope 管理商家、squad scope 管理組別。