API 目錄
整合購買、廣告、CRM、AI、電商與店鋪數位化等所有功能的 API。
可依類別與適用對象篩選，快速找到需要的 API。
驗證與存取
使用 API 需要透過 OAuth 2.0 授權碼流程進行驗證。
開發者註冊 App、企業擁有者授權存取後，即可取得權杖並呼叫 API。
1. 取得授權碼
GET /oauth/authorize ?client_id=YOUR_CLIENT_ID &redirect_uri=YOUR_REDIRECT_URI &response_type=code &scope=store.products.read &state=RANDOM_STATE → 企業擁有者在同意畫面授權 → redirect_uri?code=AUTH_CODE
2. 以授權碼換取權杖
POST /api/v1/auth/token
Content-Type: application/json
{
"grantType": "authorization_code",
"clientId": "YOUR_CLIENT_ID",
"clientSecret": "YOUR_SECRET",
"code": "AUTH_CODE",
"redirectUri": "YOUR_REDIRECT_URI"
}
→ 取得 accessToken + refreshToken
將取得的權杖設定在請求標頭中使用：
Authorization: Bearer {access_token}
請求範例
以下是取得購買資料的 API 範例。 可取得商品名稱、價格、購買店家與購買時間等資訊。
GET /api/v1/store/receipts/{id}
Authorization: Bearer {access_token}
{
"store": "Example Store",
"total": 842,
"items": [
{ "name": "咖啡（中）", "price": 180 },
{ "name": "三明治", "price": 420 }
],
"timestamp": "2025-11-11T10:32:45Z"
}
查看所有端點（API 參考文件）
OpenAPI 規格（機器可讀）
所有端點的定義皆以 OpenAPI（Swagger）格式公開。
只要將此 URL 提供給 AI 程式設計助理或程式碼產生工具，即可自動產生具型別的 API 用戶端。
https://receiptroller.io/openapi/v1.json
透過 Webhook 即時整合
發生購買或廣告點擊等事件時，會即時通知您指定的 URL。
可用於與促銷 App 或內部分析系統自動整合。
POST /webhook/purchase
{
"event": "purchase.completed",
"receipt_id": "rcp-8421093",
"total": 842,
"timestamp": "2025-11-11T10:32:45Z"
}