API介紹以及使用(以Notion API+Postman討論)

--

相信大家一定都聽過API,全名為Application Programming Interface應用程式介面,那究竟這個是什麼東西呢?相信網路上一定有很多講得更好的人(Ex: API 到底是什麼? 用白話文帶你認識 — Medium…),這邊就不多做解釋了。

當然, API 其實不限於 web application ,任何應用程式都可以開發 API 供開發者使用,像是瀏覽器也提供了許多 API 讓前端開發人員可以使用瀏覽器提供的服務或功能(ex: 操作 DOM、使用 Geolocation 取得使用者的地理位置等等) — (擷至Jimmy 的架站筆記)。

可是Web API是最大宗,所以我們這邊討論的是這個(以Notion為例)。最後有關API的是,基本上很多大WEB應用都有API,像是Google map, ClickUP, Teams, Notion, Google Drive…,很多東西都有,而相對的使用API要遵守他們的規定,所以他們會把規定以及使用方法寫成一個文件(document),以notion為例就在這邊(只要查notion API document關鍵字就會有了)。

並且web API底層原理通常為http request,所以大家可以對這些底層動作有更深入的了解,Postman就是一個幫我們專門測試http request的網站。

API是什麼?認識 Web API、HTTP 和 JSON 資料交換格式

notion文件的目錄如上,基本上我們只關注左邊guides, API reference。

  1. 認證

用到API的時候當然不是想對誰用就用,假如你要對某個Notion帳號使用,你要做些動作,這些在Guide都有教。

2. 實際使用

最主要看API reference,如下圖,也有看到認證的部分,

我們已create a page這個api為例,可以看到它是post請求。然後她會講說那個http post需要什麼參數,或者headers,或者body

如同以上,講說要parent跟properties以及一些headers,所以其實http就是透過這些參數來處理是否在創建頁面時要放東西,或者放icon。

並且透過postman就可以來實際使用這些http request。postman教學

--

--

Kola (Yan-Hao Wang)
Kola (Yan-Hao Wang)

Written by Kola (Yan-Hao Wang)

在系統軟體跟資安領域學習的學生

No responses yet