您的 API 計畫願景是什麼?從 Twitter 最新的 API 宣言中學習 

  2017 年 4 月 11 日

上週,Twitter 為其熱門的 API 計畫推出新的願景 — 承諾為開發人員提供更「統一」的 API 平台,以利用 Twitter 的公開 API 來建置應用程式。在公司企業部落格上的一篇文章中,標題為 建構 Twitter API 平台的未來,Twitter 預覽了幾項重大變更,包括 更統一的 API 平台: Twitter 承認,自從公司在 2014 年收購社交資料供應商 Gnip 以來,其開發人員社群在某種程度上已經分裂。雖然大部分的開發人員基礎仍然繼續使用 Twitter 的標準 REST 和即時串流 API,但越來越多的大型公司付費存取 Gnip 的企業級 API。Twitter 解釋說:「今年稍後,我們將推出新的開發人員體驗,結合標準 REST 和串流 API 的免費且輕鬆的存取,以及 Gnip 的企業級功能和可靠性。目標是建立一個整合的 Twitter API 平台,為每個人提供服務,從測試新想法的個人開發人員到 Twitter 最大的企業合作夥伴。」 新的存取層級: 雖然 Twitter 將統一其平台,但也會根據其多元開發人員基礎的需求推出新的存取層級。這將包括用於測試想法和建置新產品的免費存取層級;以及具有增強功能和速率限制的付費和企業存取,以協助組織擴展其想法。新的資料和互動 API: Twitter 預覽了新的 API,這些 API 將協助企業更好地利用其平台上大量的用戶資料。 正如 Twitter 所解釋的:「企業依靠這些公開資料來了解要建置哪些產品、如何行銷它們、他們的客戶是誰,以及人們對其產品和服務的看法。我們將推出新的 API,以協助開發人員建置可為企業解鎖新洞察的產品。」他們還預覽了新的 API,這些 API 將協助開發人員建置專注於利用 Twitter 資料來改善客戶服務和自動化的應用程式。未來的公開路線圖: Twitter 1,200 多字公告中最值得注意的部分之一是,該公司首次發布了截至 2018 年初的 API 計畫公開路線圖。這包括有關他們在 2017 年已經交付的新產品的更新,以及將在今年剩餘時間內推出的新產品和功能的概要。

這個最新公告對您來說意味著什麼?

如果您是一位依賴 Twitter 公開 API 來建置和擴展應用程式的開發人員,那麼最新的公告為該平台的未來提供了許多令人興奮的地方。但是,API 提供者也可以從 Twitter 的最新公告中學習一些重要的經驗,以建置自己成功的 API 計畫。以下是一些需要考慮的重點

1. 確定您的計畫存在的原因

在深入探討 API 平台的新內容之前,Twitter 先概述了其 API 計畫的目的及其存在的原因:「我們的 API 平台透過開發人員生態系統的幫助,使我們能夠為用例提供服務並鼓勵創新,從而為 Twitter 上的每個人帶來更好的體驗。」 雖然這似乎是顯而易見的第一步,但許多組織在沒有明確的願景要實現什麼的情況下,就匆忙投入開發 API 計畫。雖然您的組織有很多理由投資於建置 API,但該計畫的成功將取決於了解其目的並為您試圖吸引的人提供價值。您是否試圖在較小的規模上建立合作夥伴關係?您是否想吸引成千上萬的開發人員,並為您的平台開啟新的創新機會?在開始之前,請對您的計畫有明確的願景。

2. 仔細思考開發人員體驗

Twitter 最近的公告清楚地表明了開發人員體驗在當今 API 經濟中的重要性。Twitter 本身已經承認,他們並未總是為在其平台上建置應用程式的開發人員提供最佳體驗,並且已採取措施改善與應用程式開發人員的關係。他們將分散的 API 計畫統一為一個平台,並提供不同的存取層級,這是一個很好的例子,說明組織應如何根據其受眾的需求調整其 API 計畫。良好的開發人員體驗始於了解使用您 API 的不同受眾。然後,您可以規劃他們將如何使用您的 API,以及他們在 API 生命週期中需要什麼。以 Twitter 為例,為開發人員提供免費的存取層級,以測試新想法並開始建置新應用程式,是一個很好的起點,讓他們從一開始就提供出色的開發人員體驗。

3. 清晰有效地溝通

API 應該像您的團隊交付的任何軟體或應用程式一樣,受到同等的重視。這意味著,就像您希望清楚地溝通核心產品的變更一樣,您也希望清楚地與您的 API 最終用戶溝通。並非每個更新都需要冗長的部落格文章,或向您的基礎用戶發布高度公開的公告。但是,您應該有一個流程來讓您的最終用戶了解會影響他們如何使用您 API 的變更。此時,API 管理工具可能會派上用場,可以快速存取已使用您 API 的使用者清單。而且,擁有API 生命週期管理解決方案也很重要,可以處理從規劃、設計、部署到淘汰的 API 生命週期的所有階段。

4. 以完善的文件支援您的計畫

卓越的開發者體驗始於卓越的 API 文件。在 Twitter 平台上推出的變更背後,有對開發者有幫助的文件,讓開發者了解如何使用 Twitter 的服務。API 文件是成功使用並整合 API 所需的資訊。這將以技術寫作、程式碼範例和範例的形式呈現,以便更好地理解如何使用 API。一個健全的API 文件工具,例如 SwaggerHub,可以透過提供一個中央平台來協助團隊設計和記錄您的 API,並提供即時視覺化的文件呈現、完全託管且無需設定的文件,以及具有分支、差異和合併的受控工作流程。無論您如何管理 API 文件,請確保您的最終使用者可以輕鬆存取他們在與您的 API 互動時成功所需的資訊。我們很高興看到 Twitter 的 API 計畫未來會有什麼發展。如需更多關於為當今 API 經濟建構 API 計畫的提示,請查看我們的最新電子書:如何為當今的 API 經濟最佳化您的 Swagger 工作流程