這是一篇關于 API 調用的快速入門文章。我們已經發布了關于API 端點和API 密鑰的文章,如果你還沒讀過,請點擊此處。
API 調用或 API 請求是從客戶端發送到服務的信息。您通常使用 API 密鑰向端點發出 API 調用。您可以將這種調用比作寄信,而端點則充當郵箱或目標地址。
要建立呼叫,您需要提供以下信息:
每個處理 API 調用的服務都會不斷監聽要處理的請求。
(對于網絡流量,這些服務通常監聽 80 或 443 端口。)這些服務會檢索客戶端請求,確保其中包含適當的安全數據(如 API 密鑰、標頭),解壓縮所用的參數和數據,然后向客戶端返回響應。
下面是一個 API 調用示例,你可以在終端上試用(此功能已內置到 macOS 和 Linux 中):
curl https://api.github.com/repos/torvalds/linux
這將使用 GitHub REST API 返回有關 Linux 內核代碼的一些信息。你可以用各種編程語言調用 API。
讓我們用Postman 這個擁有出色用戶界面的網絡 API 平臺,以更直觀的方式來看看另一個例子。它是一個非常有用的工具,可用于試用公共 API。我們的示例將使用 JSON 參數和標頭創建一個請求。然后,Postman 將請求數據并顯示我們收到的響應。
要使用 Contentful API 檢索給定空間中的所有內容類型,我們可以使用以下端點:
https://cdn.contentful.com/spaces/nxk0n1u8oy59/content_types
如果在 Postman 中以 GET 請求方式直接輸入該端點,則會收到如下"401 未授權 "
狀態和要求提供訪問令牌的錯誤信息:
現在,如果使用授權選項卡或手動添加頭,將訪問令牌添加到請求頭中,就會得到以下結果:
響應標頭還會返回有關接收請求的端點的元數據,包括組織 ID 和請求來自的地區。
雖然這個示例是一個只讀 API,但其他 API 也允許你向目標系統推送信息。如果您想建立一個創建或更新數據的請求,它通常看起來像下面這樣:
GET
改為POST
(或任何其他 http verb)。然后,您的數據將通過請求正文發送給服務。
現在你知道如何使用 Contentful 或其他方法調用 API 了吧。需要提醒的是,API 無處不在,它為我們使用的每項技術提供動力,不僅是網站,還有您的 iOS/Android 應用程序,可能還有您的烤面包機。查看我們關于API 端點和API 密鑰的其他文章。希望對你有所幫助!