RSS 連結和 API:在其他應用程式中使用你的 FeedBro 閱讀內容

RSS 連結和 API:在其他應用程式中使用你的 FeedBro 閱讀內容

你可以用兩種方式,在其他應用程式和工具中使用你在 FeedBro 的閱讀內容。RSS 連結會把你的已儲存文章或某個收藏集變成訂閱來源,任何 RSS 應用程式或自動化工具都能讀取,完全不需要設定。開發者 API 則讓你自己的程式和應用程式讀取你的訂閱來源和文章;使用 Coffee Club 時,還能把文章標示為已讀或已儲存。

設定的 API 分頁:今天的用量、你的金鑰,以及建立新金鑰的方塊。
設定的 API 分頁:今天的用量、你的金鑰,以及建立新金鑰的方塊。

以 RSS 連結取得你的閱讀內容

RSS 訂閱來源是一份最新文章清單,應用程式可以檢查它有沒有更新。FeedBro 會為你自己的清單提供私人 RSS 連結:

廣告
  • 已儲存:你在 FeedBro 中儲存的文章。所有方案都有這個連結。
  • 每個收藏集一個連結,內容是該收藏集中所有訂閱來源的最新文章。這是 Coffee Club 的功能。

你可以用它們把已儲存的文章傳送到其他閱讀器應用程式、「稍後閱讀」服務、團隊聊天室,或任何支援 RSS 的自動化工具。

如何複製你的 RSS 連結

  1. 在 feedbro.com 登入,開啟設定(從個人資料照片下方的選單)。
  2. 點選訂閱來源分頁。
  3. 找到以 RSS 取得你的閱讀內容卡片。
  4. 在已儲存旁邊(使用 Coffee Club 時,也在每個收藏集名稱旁邊)點選複製。按鈕會短暫變成已複製。你也可以在方塊內點一下來選取連結。
  5. 把連結貼到其他應用程式要求輸入訂閱來源網址的地方。

在免費方案中,你的收藏集會帶著鎖頭圖示列出,並附上說明「收藏集連結是 Coffee Club 的功能。」使用 Coffee Club 時,如果你還沒有任何收藏集,卡片上會顯示「建立收藏集後,也會有它的 RSS 連結。」

每個項目包含什麼

  • 文章標題,以及連到發布者網站上原始文章的連結。
  • 訂閱來源本身發布的簡短摘要(最多約 600 個字元),如果有的話。
  • 發布日期。

FeedBro 擷取到的文章全文不會包含在內。在其他應用程式中點選項目時,會開啟原始頁面。

各方案的限制

在免費方案中,你只有「已儲存」連結,內容是你最新的 20 篇已儲存文章。它最多每 15 分鐘更新一次。

在 Coffee Club 中,你有「已儲存」連結和每個收藏集的連結,每個連結各有 50 篇文章。它們最多每 5 分鐘更新一次。

如果你離開 Coffee Club,收藏集連結仍然可以開啟,但 RSS 應用程式只會顯示一個項目,內容是「收藏集連結是 Coffee Club 的功能。」

請把連結保密

這些連結包含一組祕密代碼,不需要登入就能使用,這樣其他應用程式才能讀取。這也表示任何拿到連結的人都能讀取那份清單,所以請不要分享給別人。

如果不小心分享了連結:

  1. 開啟設定,再開啟訂閱來源分頁。
  2. 在以 RSS 取得你的閱讀內容中,點選重設連結。
  3. 你會看到「舊的 RSS 連結已失效,新的連結在下方。」請把新連結複製到你還想使用的應用程式中。

重設會一次停用所有舊連結:包括「已儲存」連結和所有收藏集連結。

開發者 API

API 是讓程式直接和 FeedBro 溝通的方式。有了個人 API 金鑰(一組很長的祕密代碼,作用就像某個程式專用的密碼),程式或應用程式就能以 JSON(程式讀取的一種簡單文字格式)讀取你的訂閱來源、收藏集、文章和已儲存的頁面。它使用的是你自己的帳號,所以它做的變更會出現在 FeedBro 中,反之亦然。

各方案的限制

在免費方案中,你有 1 個金鑰,每月 500 次請求,每個金鑰每分鐘最多 30 次請求,僅限讀取。

在 Coffee Club 中,你最多有 5 個金鑰,每天 100 次請求,每個金鑰每分鐘最多 60 次請求。金鑰還可以把文章標示為已讀、已儲存或稍後閱讀。它們可以啟動背景工作(例如擷取文章全文,或從任何網頁取出主要文字),並把結果傳送到 webhook(你自己伺服器上的一個網址,FeedBro 會在工作完成時呼叫它)。

免費方案的每月計數在每月 1 日重新開始,Coffee Club 的每日計數則在 UTC 午夜重新開始。大多數請求算 1 次。背景工作做的事情比較多,所以算的次數也比較多:擷取文章或擷取頁面內容算 10 次,追蹤訂閱來源算 5 次,開始監看網站算 25 次。如果工作失敗,只算 1 次,其餘的會退還。

如何建立 API 金鑰

  1. 開啟設定,點選API分頁。
  2. 在API 存取卡片中,在方塊裡輸入金鑰的名稱(例如「我的程式」),之後才能分辨不同的金鑰。
  3. 點選建立金鑰。
  4. 金鑰會出現,並附上訊息「請立即複製這個金鑰,它只會顯示一次。」點選複製,把金鑰存放在安全的地方,例如密碼管理工具。

你的金鑰會列在同一張卡片中,附上名稱和上次使用的時間(在第一次請求之前顯示「尚未使用過」)。若要停用某個金鑰,請點選它旁邊的撤銷並確認。如果你遺失了金鑰,請撤銷它,再建立一個新的。

如何查看你已使用多少

API分頁頂端的用量卡片會顯示,例如「本月已用 12 / 500 次請求」、還剩多少次、計數重設的日期,以及每個金鑰每分鐘可以傳送多少次請求。最近 30 天圖表會顯示你每天的請求數。在金鑰下方,最近的背景工作列出你的金鑰啟動的工作,以及它們的狀態(等待中、執行中、完成或失敗)、花了多少時間,以及算了幾次。

API 說明文件和測試區

完整的說明文件在 FeedBro API 頁面上。你可以從設定中的API 文件連結,或從每個頁面底部的開發者 API前往。它涵蓋每一種請求,並附有回應範例和每一則錯誤訊息。

這個頁面有一個名為 Try it 的測試區,你不用寫任何程式碼就能測試請求:

  1. 把你的金鑰貼到 API key 方塊中。輸入時會隱藏起來;眼睛按鈕可以顯示它。
  2. 從 Call 清單中選擇一個請求,例如 GET /summary/unread-count。下方那一行會說明它的作用、是否需要 Coffee Club,以及算幾次。
  3. 填寫顯示的欄位。標有 * 的欄位是必填的。
  4. 點選 Send。回應會出現在下方,附上狀態和你還剩多少次請求。
  5. 點選 Copy as curl,把同一個請求複製成可以在終端機中執行的指令。

測試區的請求是真實的:它們使用你的帳號,也會計入你的方案。你的金鑰不會儲存在任何地方,只會在你離開頁面之前留在方塊中。如果你使用 Postman(一個常用的 API 測試工具),這個頁面也提供 Download the Postman collection。

用白話說明第一個範例

每個請求都會送到以 https://feedbro.com/api/v1 開頭的網址,並在名為 Authorization 的標頭中帶著你的金鑰,格式是 Bearer 加上一個空格和你的金鑰。例如,程式送出 GET /summary/unread-count 時,會收到一個數字,也就是你所有訂閱來源中的未讀文章數量,以及計算出這個數字的時間。程式送出帶有 filter=unread 的 GET /articles 時,會收到你的未讀文章,每次 25 篇,最新的在前。每篇文章都附有標題、連結、摘要、圖片,以及它是否已讀、已儲存或在稍後閱讀中。

透過金鑰讀取文章,不會在 FeedBro 中把它標示為已讀。API 也絕不會讓你的程式等待網站擷取完成。它會用 FeedBro 已經有的內容回應,任何需要擷取的內容都會以背景工作執行。

小提醒

  • 請把 API 金鑰當作密碼看待,因為任何拿到它的人都能讀取你的帳號。絕對不要把它貼到公開頁面上,也不要在螢幕截圖中分享。
  • 如果某個應用程式只支援 RSS,你完全不需要金鑰。請改用你的 RSS 連結。
  • 你的 RSS 連結和 API 金鑰是分開的。重設 RSS 連結不會影響你的金鑰,撤銷金鑰也不會影響你的連結。

如果有問題

「Unauthenticated.」

金鑰遺漏、輸入錯誤或已被撤銷。請檢查 Authorization 標頭,或建立新的金鑰。

「On the Free plan an API key can read only.」或「Background jobs and webhooks are part of Coffee Club.」

這個請求需要 Coffee Club。

「Too many requests this minute. Wait a moment and try again.」

你的程式傳送請求的速度太快了。請等待回應中指出的秒數,然後再試一次。

「Monthly limit reached」(免費方案)或每日上限(Coffee Club)

在回應中和用量卡片上顯示的重設日期之前,你的請求次數已經用完了。

「免費方案包含 1 組 API 金鑰,Coffee Club 最多可有 5 組。」或「最多可擁有 5 個金鑰,請先撤銷一個。」

建立新金鑰之前,請先撤銷一個不再使用的金鑰。

我的 RSS 應用程式停止更新了

如果你點選了重設連結,舊連結就會失效。請從設定的「訂閱來源」分頁複製新連結。

我的收藏集 RSS 連結只顯示一個關於 Coffee Club 的項目

收藏集連結需要 Coffee Club。「已儲存」連結在所有方案中都能使用。

我儲存的文章還沒出現在 RSS 應用程式中

在免費方案中,連結最多每 15 分鐘更新一次,在 Coffee Club 中最多每 5 分鐘一次,而你的 RSS 應用程式也有自己的檢查時間。請稍等一下再查看。

廣告
分享

相關文章