跳至主要内容

Quick Start

從申請權限到送出第一個請求,快速掌握 FREONE API 的串接方式。

1. 確認使用情境

先整理預計串接的組織、商家或組別範圍,以及預計使用的 API。如果對這些層級不熟悉,請先閱讀 FREONE 基礎名詞。FREONE 會依申請內容建立 Service Account 並配置權限。

2. 申請 Service Account

準備公司名稱、技術聯絡人、Sandbox 與 Production Service Account Email、權限範圍與預計上線日期後,填寫 Service Account 申請表

3. 選擇環境

環境Base URL用途
Sandboxhttps://api.developer-beta.freone.com串接開發與測試
Productionhttps://api.developer.freone.com正式服務

兩個環境的 API Key 與 Secret 不共用。請勿將 Sandbox 憑證送往 Production,反之亦然。

4. 建立簽章

每次請求都必須包含 X-API-KeyTIMESTAMPSIGNATURE。請依 API 驗證與簽章 建立 canonical message,並以 HMAC-SHA256 計算簽章。

5. 取得基礎資源

開始整合前,通常先查詢 Service Account 可管理的商家與組別:

GET /v1/merchants
GET /v1/squads

取得 merchantIdsquadId 後,即可依需求串接班表組員管理員與權限 API。

完整規格

每個端點的參數、回應欄位與錯誤碼,請以 API Reference 為準。