FaFaFa.ai
幫助中心

API 對接指南

查看建立 Key、測試介面以及在你自己的服務裡完成對接的完整步驟。

如果你希望把公眾號訂閱消息接入自己的系統，建議依照下面的順序完成：

  1. 在網頁端進入「個人中心 > API Key 管理」或獨立的 API Key 頁面
  2. 建立一個新的 API Key
  3. 先在後台直接測試 API，確認 Key 可用
  4. 再把同一個 Key 配置到你的服務中

第一步：建立 API Key

點擊打開 API Key 頁面

在 API Key 管理頁中輸入一個便於識別的名稱，例如：

  • 營運後台同步
  • 飛書機器人
  • 數據倉庫增量拉取

建立後，系統只會完整顯示一次 Key，請立即複製保存。

第二步：在後台測試介面

統一 API Key 管理頁已經內建了測試能力：

  • 貼上剛建立的 Key
  • 點擊「測試 API」
  • 確認可以返回訂閱消息

如果這裡已經能成功返回，代表鑑權和介面位址都沒有問題。

第三步：在你的服務裡發起請求

請求位址：

GET https://api.fafafa.ai/api/v1/wechat/messages

這裡的網域部分來自系統環境變數 WORKER_PUBLIC_BASE_URL，頁面會依這個值自動拼接完整介面位址。

鑑權方式：

Authorization: Bearer YOUR_API_KEY

示例請求：

curl 'https://api.fafafa.ai/api/v1/wechat/messages?page=1&pageSize=20' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json'

推薦接入策略

首次拉取

使用 page 和 pageSize 分頁讀取歷史消息，先完成初始化。

增量拉取

保存你上一次成功處理的時間，之後帶上 since 參數，只拉取這個時間之後的新消息。

curl 'https://api.fafafa.ai/api/v1/wechat/messages?since=2026-03-19T00:00:00.000Z&page=1&pageSize=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

冪等處理

建議按文章唯一標識或原文連結去重，避免重複入庫。

常見聯調建議

  • Key 洩露後，直接在後台刪除舊 Key，並重新建立一個
  • 測試環境和正式環境建議使用不同名稱的 Key，方便排查
  • 同一個 Key 也可以重用於 MD 檔案匯入 API，不需要額外再申請一套
  • 如果你的系統暫時沒有消息返回，先確認網頁端是否已有有效訂閱

建議繼續在網頁端完成的操作

  • 新增訂閱
  • 取消訂閱
  • 查看額度與方案
  • 建立、刪除和輪換 API Key

API 更適合「消費訂閱消息」，網頁端更適合做日常管理。