坐在舒適的沙發上，我可以輕鬆完成各種任務 - 訂購雜貨、送餐、繪製前往 Barnes & Noble 的路線圖，以及查看天氣以確定留在室內是否是最佳選擇。雖然有些人可能認為這很懶，但我認為它非常方便。我將這些便利歸功於 API 的強大功能。

API 是現代便利設施的關鍵推動者，是將不同應用程式黏合在一起的黏合劑。這些程式介面允許跨不同平台的無縫通訊和資訊共享，促進為我們的日常生活提供動力的整合。此外，API 承擔了開發新應用程式所需的大部分複雜後端工作，簡化了創新數位工具和服務的建立。

我編寫了一份關於如何使用 API 的詳細初學者指南和教學。

目錄：

• [什麼是API？

• [為什麼要使用API？

• [API 入門]

• [如何使用API]

• [REST、GraphQL 與 SOAP API]

• [API類型]

• [API常見問題]

什麼是 API？

API 充當數位中介，允許不同的軟體應用程式相互溝通和共享資訊。它概述了開發人員可以用來存取功能或從應用程式或線上服務檢索資料的具體方法、參數和資料格式。

考慮一下您的首選天氣應用程式 - 它利用 API 從氣象服務獲取即時資料並將該資訊直接傳送到您的裝置。或考慮使用社交媒體登入（例如 Facebook）來存取另一個應用程式 - 有 API 在幕後工作來安全地驗證您的身分。

為什麼要使用 API？

如果沒有 API，我們將只能依靠老式的紙質地圖來找到道路，而且我可能會一直迷路。但 API 允許我們利用現有的資料來源，而不必從頭開始建立一切。例如，當您使用導航應用程式時，它會透過 API 發送請求，以存取來自手機訊號塔和 GPS 衛星的即時位置資料。

從開發人員的角度來看，API 提供了一條有價值的捷徑 - 他們可以利用預先建置的功能，使他們能夠專注於建立新的創新功能。以 Planefinder 為例，這是一款即時追蹤飛機的應用程式，他們不必從頭開始建立自己的地圖系統，而是使用了 Google Maps API。這使他們能夠騰出時間和資源來開發 Planfinder 的獨特功能和功能。

使用apidog ，您可以輕鬆促進不同系統之間的無縫集成，從而實現跨應用程式的平滑資料交換。當您的企業需要跨軟體平台共享資訊（例如將客戶關係管理 (CRM) 系統與電子郵件平台連接）時，這種整合功能被證明是非常寶貴的。 apidog建立在API技術之上，提供使用者這些便利的跨系統協作和資料共享能力。

Apidog 是一個 API 管理平台，可實現跨業務系統的無縫整合和流暢的資料共享。透過 apidog 強大的 API 功能，您可以輕鬆連接 CRM 和電子郵件平台等應用程式，從而簡化複雜的工作流程並實現有價值的跨系統協作。

API 入門

我將向您拋出大量術語，因此在開始之前，您應該了解以下一些 API 術語。

|術語|定義|

| ：------------------ | :------------------------------------------------- --------------- ---------- |

| API 金鑰|由字母和數字組成的唯一密碼，用於授予 API 存取權限 |

|端點| API 接收有關其資源的請求的數位位置 |

|請求方式|使用 HTTP 方法（GET、POST、PUT、DELETE）告訴 API 您希望它做什麼 |

| API呼叫|客戶端（您的電腦）向伺服器發出 API 請求的過程 |

|狀態碼| API 回應正文中顯示的數字程式碼，用於告訴您請求是否成功 |

| API伺服器|在提供適當的回應之前驗證並處理 API 請求 |

| API 回應| API 伺服器產生並傳回給客戶端（您的電腦）的回應 |

API 金鑰

與密碼非常相似，API 金鑰是由字母和數字組成的唯一字串，用作存取程式碼或身份驗證令牌。存取大多數 API 都需要此金鑰，因為它是追蹤和控制 API 使用情況的關鍵安全措施。就像您需要密碼才能存取應用程式一樣，您也需要有效的 API 金鑰才能存取和使用 API 的資料和功能 - 確保只有授權使用者或應用程式才能執行此操作。

我們將在下一節中介紹如何取得和使用這些金鑰。

API端點

API 端點是指充當 API 存取點的特定 URL 或 Web 位址，允許其與其他應用程式通訊。這些端點充當接收請求和發迴回應的標準化位置。它們為用戶提供了一種清晰且結構化的方式來與 API 功能進行交互，就像自動販賣機上的按鈕一樣。

就像您透過按下自動販賣機上的按鈕來選擇特定零食一樣，您可以透過向該特定 URL 發出請求來「按」API 端點。然後，API 準確地知道您正在尋找什麼資訊或操作，並為您提供相應的回應，提供您需要的數位「士力架」。

請求方式

要透過 API 端點傳達您想要完成的任務，您需要使用四種特定 HTTP 方法之一發出請求：

• GET：此方法用於從 API 檢索特定資料。

• POST：這告訴 API 您想要為伺服器新增或發布新資料。

• PUT：此方法用於更新 API 上的現有資源。

• DELETE：顧名思義，這用於從伺服器中刪除現有資料。

這些請求類型通常也稱為 CRUD - 建立、讀取、更新和刪除。許多面向公眾的 API 通常只允許 GET（讀取）請求，以防止未經授權的各方修改其資料。畢竟，您不希望任何人存取氣象 API 並更改天氣資訊。

API呼叫

API 呼叫是發出請求、讓 API 檢索所需資料、然後接收對應回應的端到端過程。您所要做的就是使用我們之前介紹的 HTTP 方法之一發出請求。

你可以把它想像成在咖啡店點一杯飲料——你告訴咖啡師你想要什麼，他們將你的訂單輸入到他們的系統中，然後把成品飲料遞給你。 API 呼叫的工作方式非常相似，只是沒有含咖啡因的結果。

狀態程式碼

當您發出 API 請求時，您將收到一個狀態程式碼 - 一個 3 位數的數字，告訴您請求是否成功。以 2 開頭的程式碼表示您的請求已成功。以 4 開頭的程式碼表示有問題。這些狀態程式碼讓您知道請求的結果。

如何使用 API

我將使用Apidog向您展示使用 API 的範例。 Apidog 是一種非常容易使用 API 的方式，它為 API 提供了使用者友善的介面。

1. 選擇一個 API

有數千個公共 API 可供使用。您可以搜尋 GitHub 或 Google 的 API Explorer 等目錄來尋找您感興趣的目錄。大多數網站都會在「進階設定」或「開發人員」部分（通常位於網站底部）下列出可用的 API。

我將使用OpenAI API 平台。

2.查閱API文件

每個 API 都應該為您提供入門文件。這通常包括一個參考部分，詳細說明您可以存取的可用物件、參數和端點。通常還有用流行程式語言表達的範例或「快速入門」指南，其中解釋了：

• API提供哪些功能

• 使用 API 的任何依賴項或要求

• 如何實際使用 API

如果 API 需要 API 金鑰，您也可以在文件中找到該資訊。

3. 寫入請求

步驟1：建立OpenAI帳戶

如果您還沒有，請前往 OpenAI 平台並建立帳戶。

第 2 步：建立專案（可選）

您已登入。這使您可以與團隊協作、設定自訂計費限額並更好地了解使用情況。

如果您想使用此功能，請在螢幕左上角按一下「預設專案」 ，然後按一下「建立專案」 。 （您也可以從此處造訪組織概述頁面。）

第 3 步：建立 OpenAI API 金鑰

由於 OpenAI API 不是免費的，因此您需要建立一個 API 金鑰，以便平台知道您是誰以及向誰收取工作費用。若要產生 OpenAI API 金鑰，請查看螢幕右上角，然後按一下儀表板。

這就是我之前提到的OpenAI Playground。它擁有使用 OpenAI API 進行測試和開發的所有工具。閱讀彈出的歡迎訊息後，您可以點擊“開始”繼續。

關閉彈出視窗。在左側選單上，按一下API 金鑰。

在螢幕右上角，按一下「建立新金鑰」 。注意：只有使用電話號碼驗證帳戶後，您才能建立 API 金鑰。

將出現一個彈出窗口，其中包含您的 API 金鑰設定。我將在一秒鐘內引導您完成所有這些。

在名稱下，為您的 API 金鑰指定適當的名稱或服務名稱 ID。

如果您建立了一個專案來管理 API 金鑰，請按一下下拉清單將其選取。否則，您可以將其保留為預設設定。

最後一個設定可讓您調整該鍵的權限：

• All允許完全存取所有 API 功能。

• 受限允許您選擇此鍵有權存取哪些模型和任務。例如，如果您僅使用文字生成，則可以將模型功能設為Write ，將所有其他功能設為None 。

• 只讀會阻止所有寫入請求，這對於將資料拉入外部系統很有用。

考慮將其設定為執行您需要的操作所需的最低權限等級。

調整完這些設定後，點擊建立金鑰，平台將為您產生一個金鑰。您將無法再次看到此金鑰：暫時將其複製並貼上到安全位置，並在下一步中設定通話後考慮將其丟棄。

單擊“完成”後，新密鑰將加入到列表中。您以後隨時可以刪除或編輯名稱或權限。

步驟 4：開啟 API 文件和參考頁面

根據您要使用的 API 功能，進行和建構 API 呼叫會有所不同。要了解如何繼續，您需要找到：

• 文件頁面，為您提供 API 功能及其使用方法的總體概述。這是文字產生功能的文件。

• API 參考頁面，其中包含您需要打包到請求中的所有技術規格。以下是聊天完成端點的 API 參考（我們將使用它來執行文字產生作業）。

利用 API 提供的所有功能意味著您必須隨著時間的推移熟悉這些頁面。如果您遇到麻煩或正在集思廣益新的用例，請務必記得回來閱讀更多內容。

您可以使用螢幕右上角的連結在文件和 API 參考之間來回導航。

對於此範例，我想使用聊天完成端點，因此我將導航到 API 參考中的相應頁面。首先，我們需要複製端點 URL ( https://api.openai.com/v1/chat/completions ) 並記下 HTTP 方法，在本例中為 POST。

第 5 步：建立新請求

您可以使用 Apidog 發送 cURL 請求。 Apidog是一款功能強大的 API 開發和測試工具，為開發人員提供了一系列功能和優勢。與 Postman 一樣，Apidog 允許用戶發送 cURL 請求，這對於已經在終端機或命令列介面中熟悉 cURL 的人來說特別有用。利用 Apidog 的使用者友善介面和眾多功能，您可以輕鬆建立和發送 cURL 請求以及其他類型的請求。這使開發人員能夠有效率地測試 API，快速辨識和除錯潛在問題，並最大限度地提高 API 開發工作流程。

1.透過官方文件或存取Apidog上的OpenAI API專案，從左側選單中選擇Chat Completions API端點，並在新請求畫面上，根據ChatGPT規格輸入HTTP方法和端點URL。然後，在「正文」標籤中，以 JSON 格式寫入要傳送至 ChatGPT 的訊息。

2：切換到「標題」標籤，新增授權參數以使用 ChatGPT API 進行身份驗證，輸入您獲得的 ChatGPT API 金鑰，然後按一下「傳送」按鈕。

注意：在 Apidog 中，您可以將 OpenAI API 金鑰儲存為環境變數。將 OpenAI API 金鑰儲存為環境變數意味著您以後可以直接引用環境變數，而無需重複重新輸入 API 金鑰，非常方便。

REST、GraphQL 與 SOAP API

• REST（表述性狀態傳輸）API或 RESTful API 是當今最常見的 API 形式。它是基於網路的，這意味著資訊是在線上交換的。當您使用 REST API 發出請求時，您將收到該 API 提供的所有資料。

• GraphQL（查詢語言）API以類似的方式運作，只不過它們只獲取並回應您想要的特定資料，而不是獲取全部資料。因此，您可以指定所需的字段，並避免大量資料交換和隨後的載入速度問題。 GraphQL API 相對較新，因此並不常見，但越來越受歡迎。

• SOAP（簡單物件存取協定）API使用 XML（可擴充標記語言）（一種程式語言）進行通訊。它們是 2000 年代初期不同軟體應用程式之間溝通的標準化方法。從那時起，它們的受歡迎程度顯著下降，因為與 REST 和 GraphQL 等替代方案相比，它們更加複雜且不靈活。

API 類型

API 有四種分類方式，每種方式都有自己的使用者和權限。

開放API

這些是公共 API，可讓開發人員存取平台的服務或資料。它們還可以用於第三方整合。以下是一些範例：

• Google 地圖 API：任何人都可以使用此 API 將 Google 地圖整合到他們的應用程式中，以提供對地圖和基於位置的服務的存取。

• Notion API：這個開放的 API 允許使用者將 Notion 工作區與其他軟體連接。

• OpenAI API ：** 此 API 允許開發人員將 GPT-4o API 和 Whisper API 與其他應用程式連接。

• Discord API： Discord 頻道可以使用此 API 與外部應用程式整合。

合作夥伴API

這是為合作夥伴或選定的第三方實體建立的一種 API。它們提供對某些功能或資料的受限存取，通常用於平台與其合作夥伴之間的整合。以下是一些範例：

• Facebook 登入 API：第三方應用程式可以使用此 API 使用 Facebook 憑證進行使用者驗證，以獲得輕鬆的登入體驗。

• Airbnb合作夥伴API： Airbnb的合作夥伴經理將親自聯繫潛在合作夥伴以實施此API，該API整合了外部預訂和其他系統。

• eBay API： eBay 為加入 eBay 開發者計畫的使用者提供許多 API，包括銷售 API、購買 API、商務 API 等。

內部API

這些也稱為私有 API，它們是由組織出於內部目的而建立和使用的。它們促進內部系統之間的通訊和資料共享。因為這些是私人或專有流程的一部分，所以它們通常不是公共知識。這是一個例子：

• 亞馬遜 API：亞馬遜員工僅透過內部 API 共享資料，幫助他們多年來持續擴展。

複合 API

複合 API 也稱為編排 API，它整合了多個 API 的資料或功能。它們充當客戶端的單一入口點，並透過統一的介面簡化與多個 API 互動的複雜性。這裡有幾個例子：

• Twilio API：此API整合了多種通訊管道，讓使用者可以建立全面的通訊解決方案。

• Salesforce 複合 API：此 API 在一次呼叫中執行多個 Salesforce API 請求。

API 為建立創新應用程式和服務提供了無限的機會。但如果您只想使用 API 來整合您的應用程式或自動化您的工作流程。

API常見問題解答

就像涉及程式碼、資料和伺服器的任何事物一樣，如果您不是開發人員，API 可能很難理解。但如果你已經做到了這一步，那麼你的狀態就很好。如需解答揮之不去的問題，請繼續閱讀。

如何從 API 存取資料？

API 用於從一個或多個伺服器存取資料，而不需要使用者去搜尋資料。但如果您想更仔細地查看資料（即查看矩陣），您可能需要開發人員存取您選擇的 API。

API 有哪 4 種類型？

四種最常見的 API 類型是開放式、合作夥伴式、私有式和複合式。開放 API 可供公眾存取。合作夥伴 API 僅可供選定的使用者或團隊存取。私有API供公司內部使用。複合 API 將多個 API 整合到一個統一的介面。

什麼是 API？

API 是連接不同應用程式的應用程式介面，允許它們進行通訊和交換資料。如果您使用手機或電腦（確實如此），您可能一直在與 API 進行交互，而沒有意識到。

如果您想自己實作一個，您首先需要找到一個公共 API 並溫習您的編碼知識。

原文出處：https://dev.to/fallon_jimmy/how-to-use-an-api-a-tutorial-for-beginners-1m5a