基礎說明
透過 Backme 提供的 API，您可以取得專案的金額、人次、回饋商品銷售狀態... 等相關資訊。
您可以利用這些資訊，讓團隊中的設計師、工程師架設出屬於自己的 獨立集資網站 或是 專案集資條 。
案例如下：
《愛閱二手書坊》的集資條
《國際橋牌社 2 》的集資條
API 常用欄位說明
在 Backme 提供的 API 中，已包含「整個專案」跟「單一回饋商品」的資料欄位。
一般狀況下，會用到的欄位介紹如下：
- start_date：專案開始時間、回饋商品的開放購買時間。
- end_date：專案預計結束時間、回饋商品的關閉時間。
- status：專案開啟或關閉、回饋商品開放或關閉。
- publish = 已發佈，意指此項目正處於「開啟中」的狀態。
- draft = 草稿，意指此項目正處於「關閉中」的狀態。
- money_goal：集資目標金額。
- backer_count：已繳款的訂單數量。
- pledged_count：已繳款的回饋商品交易總量。（一次交易 N 個項目，就會計算 N 次）
- quantity_limit：回饋商品後台設定的庫存上限。
- price：回饋商品在後台設定的價格。
- unit：此回饋商品一個所包含的單元數量。
- money_pledged：目前集資的金額，含運費。
- tags：回饋商品在後台設定的標籤。
- category：回饋商品在後台設定的分類。
- recurring_backer_count：
定期定額主單「每期付款中」與「已暫停」的總數。（ N 位支持者訂閱中） - wait_count：ATM 或 超商付款，等待付款中的訂單數量。
- wait_pledged_count：等待付款的回饋商品總量。（一次交易 N 個項目，就會計算 N 次）
- total_shipping_fee: 總運費。
- money_pledged_without_shipping_fee：目前總集資金額，不含運費。
- normal_pledged_money_without_shipping_fee：
專案「一般訂單」的目前集資總金額，不含運費。 - recurring_pledged_money_without_shipping_fee：
專案「定期定額」的目前集資總金額，不含運費。 - recurring_money_per_period_by_month：
每月定期定額「每期付款中」與「暫停中」的單期總金額，不含運費。 - recurring_money_per_period_by_year：
年繳定期定額「每期付款中」與「暫停中」的單期總金額，不含運費。
API 應用範例
A. 商品剩餘庫存量
由於回饋商品在「等待付款」的狀態時，也會佔用後台的「商品庫存」。
因此前台要正確顯示庫存量，公式如下：
商品剩餘庫存量 = (quantity_limit) - (pledged_count) - (wait_pledged_count)
B. 往後計算一年之預計募集金額
如您的定期定額商品為「月繳、無限期」的方案，可以直接採用此算法。
預計募集金額 = (recurring_money_per_period_by_month)*12 + (money_pledged)
注意事項：
1. 上述算法會包含定期定額主單「暫停中」的金額。
2. 由於是 往後計算一年，而 (money_pledged) 也包含定期定額已收到的款項，因此算出來的預計募集金額中的「定期定額金額」實際上會是 13 期以上 的總金額。
3. 如需將已收到的運費扣除，則需將 money_pledged 改為不含運費的(normal_pledged_money_without_shipping_fee + recurring_pledged_money_without_shipping_fee)
4. 如您的定期定額方案有各自的期限設定，還記得將 (recurring_money_per_period_by_month)*12 改成各個方案的的對應欄位，以組成適合您的計算公式。
API 設定為 Backme 的進階付費功能，若您需使用此功能或相關支援，請來信與我們聯繫。