API
Application Programming Interface
什麼是 API?
- 程式之間交流的「窗口」
- 事先約定要求什麼、怎麼要求
- 服務串接的基礎
API 真正改變的,是「哪些東西由我們自己開發」的界線。地圖、付款、通訊軟體通知發送、翻譯、AI 回覆等,過去需要開發團隊花數月才能完成的功能,現在只要註冊、取得金鑰,就會變成當天下午就能接上的零件。因此企劃會議的問題也從「我們能不能做出來」,變成「這個功能要用哪家公司的服務」。
實務上會遇到的形式大致分幾種。我們主動詢問就會得到回覆的是 REST(基本款);只取所需欄位的GraphQL;以及相反地,由對方在事件發生時主動推送的Webhook(網路鉤子)。付款完成或出貨開始這類不知何時會來的消息,比起每 10 分鐘詢問一次,用 Webhook 接收較為合適。接入前要確認的是驗證方式、呼叫次數上限、計費單位三件事。「每分鐘 60 次、每月 1 萬次免費」這類條件,日後可能會徹底改變設計。
也建議一併整理相近的概念。SDK是為了讓各語言更好用而打包 API 的工具組;連畫面一起整包嵌入的小工具,雖然容易接上,但可以客製化的空間較小。外部取得資料才算 API 嗎?並非如此。在公司的訂單系統與庫存系統之間架設一套內部 API,各部門用 Excel 互傳檔案的情況就會消失。評估階段先確認是否有文件與沙盒(測試環境)。
最常見的事故,是把 API 金鑰直接寫在原始碼或共用文件中。金鑰外洩後,若他人用我們的帳號呼叫 AI,帳單仍會寄到我們這裡。第二種則是假設對方服務會永遠存在的心態。外部 API 停機 30 分鐘,我們的服務也會一起停擺,若錯過版本終止公告,某天早上整合就會全面中斷。設計時不能只考慮如何串接,還要事先訂好重試規則、替代路徑與用量警示。
API 的概念從軟體發展初期就已存在。如今網頁 API 的事實標準 REST,則是由 Roy Fielding 在 2000 年的博士論文中定義的。
我們用一個假設案例來說明。A 公司是全體員工 90 人、年營收 KRW 24,000,000,000 (≈ US$17,963,300) 的室內建材經銷商。自家官網與 3 個電商平台每天約湧入 400 多筆訂單,客服團隊 2 人每天一早都要到各網站下載 Excel,再手動輸入庫存系統。光是這項作業每天就要 2 小時 30 分鐘;因為庫存不是即時更新,每月還會發生 3 次把已售完商品賣出去、導致誤出貨的狀況。
- 物流組金課長在電商平台的賣家中心翻找時,發現了「訂單查詢 API」文件,並在會議上說:「不用再按下載按鈕,系統就能自動把資料抓回來,原來可以這樣做。」
- 改為由公司內部的 DX 負責人 李代理 全程參與,花 3 週時間,開發出一支腳本:每 10 分鐘從 3 個市集的訂單 API 抓取新訂單,寫入庫存資料庫,而不是外包開發。
- 測試第二週撞上每日呼叫上限 1,000 次,下午的訂單延遲了 4 小時。李代理放棄全量查詢,改採Webhook 方式,讓市集在訂單產生時主動通知。
- 資訊安全負責人朴組長看到 API 金鑰寫在團隊共用的 Google 試算表上,叫停了這件事。「這就像把銀行存摺密碼貼在牆上。」金鑰全部重新發行,改存入伺服器環境變數。
- 上線兩個月後,人工輸入的 2 小時 30 分鐘縮減為每天 10 分鐘檢核,錯誤出貨從每月 3 件降為 0 件。客服 1 人改為專職諮詢回應,等待回應時間從 12 分鐘縮短為 4 分鐘。
Seung-tae Park
金鍾赫