lihi API 功能是什麼？如何取得 API 金鑰？

這篇文章會教你 lihi API 功能可以做什麼，以及如何取得 API 金鑰。lihi API 分為兩種：基本 API 為 Starter 以上方案可用，可建立短網址（與 Google 試算表共用同一組 API 金鑰），並可透過簡訊 API 發送簡訊與 OTP；商用 API 需 Business 以上方案，可查詢、修改、刪除單一短網址，也能批次查詢、建立、刪除，以及依標籤與建立日期查詢短網址。

如果只是需要一次建立多筆短網址，也可以先參考 Excel 批次匯入功能，不一定需要使用 API 串接。

哪些方案可以使用 lihi API？

lihi API 分為基本 API 與商用 API。Free 方案無法取得 API 金鑰；Starter 方案可使用基本 API，Business 與 Enterprise 方案可同時使用基本 API 與商用 API。

項目	基本 API	商用 API
適用方案	Starter 以上	Business 以上
主要功能	建立短網址；透過簡訊 API 發送簡訊與 OTP	查詢、建立、修改、刪除單一短網址；批次查詢、建立、刪除；依標籤與建立日期查詢短網址
驗證方式	短網址使用 API 金鑰（與 Google 試算表共用）；簡訊與 OTP 使用 Verify Token	API 金鑰
金鑰外洩時	請洽客服協助	可在後台點擊「重新產生」

如何取得 API 金鑰？

1. 確認 lihi 會員方案為 Starter 以上。
2. 登入 lihi 短網址後台，點選左側選單進階工具 > 串接 API。
3. 在 API-KEY 欄位點擊「複製」，取得 API 金鑰。
4. 串接時在 Header 帶入 Authorization: x-api-key:[API_KEY]，即可開始呼叫 API。

lihi API 可讓工程團隊透過系統串接，自動建立、查詢、修改或刪除短網址。適合用於大量短網址產生、後台系統整合、活動連結管理與批次維護等情境。

串接完成後，當您發布文章或頁面的長網址時可以同時自動生成自家網域的短網址，
同時可依需求指定slug(自訂網址)/tag(標籤)。
串接API KEY請至API功能複製金鑰，萬一串接金鑰被盜用或失效，商用 API 可點擊「重新產生」按鈕，基本 API 請洽客服。
提醒：API 金鑰具有帳號操作權限，請勿公開貼在文章、截圖、前端網頁或公開 GitHub 儲存庫中。若懷疑金鑰外洩，商用 API 請立即重新產生 API 金鑰，基本 API 請聯繫客服協助，並同步更新串接系統中的設定。

注意：一旦重新產生 API 金鑰，舊的金鑰將會立即失效，原本串接中的系統也需要同步更新新金鑰。

當串接完成的短網址會顯示在API功能的網址列表，介面與首頁相同

lihi API 可做哪些操作？

lihi API 可協助你進行短網址串接，常見用途包含（除建立短網址外，以下操作皆屬於商用 API，需 Business 以上方案）：

• 自動建立短網址

• 查詢既有短網址資料

• 修改既有短網址的目的網址

• 刪除短網址

• 搭配自訂 slug 或標籤進行管理

API 適合需要大量建立短網址、批次維護連結、或將短網址功能整合到自家系統的團隊使用。

---

如何查詢既有短網址資料？

若要查詢一筆既有短網址的資料，可以使用：

GET /api/v1/url?type=short&url=https://domain/slug

其中：

• type=short：代表要查詢的是短網址

• url=https://domain/slug：代表要查詢的完整短網址

查詢成功後，回傳內容會包含短網址、目的網址與點擊數等資料，例如：

• shortUrl：短網址

• click：總點擊數

• repeatClick：重複點擊數

• longUrls[].url：目前導向的目的網址

• longUrls[].click：該目的網址的點擊數

注意：不能只呼叫 /api/v1/url。若未帶入 type 或 url，系統會回傳 400 validation error。

---

如何修改既有短網址的目的網址？

若要修改一筆既有短網址的目的網址，可以使用：

PUT /api/v1/url
Content-Type: application/json
Authorization: x-api-key:您的_API_KEY

Body 範例如下：

{
  "shortUrl": "https://domain/slug",
  "longUrl": "https://new-destination.example/"
}

其中：

• shortUrl：要修改的既有短網址

• longUrl：新的目的網址，也就是更新後要導向的網址

若更新成功，會回傳：

{
  "result": "success"
}

若回傳 400 或 422，通常代表缺少必要欄位、網址格式不正確，或該短網址不屬於此 API key 對應的帳號或群組。

---

批次修改大量短網址時的建議

若需要批次修改大量既有短網址的目的網址，建議先整理好 shortUrl → 新目的網址 的對照表，再由工程端透過 PUT /api/v1/url API 批次更新。

為避免誤改大量短網址，建議正式處理前先以 5–10 筆測試資料進行驗證，確認更新結果與導向行為都正確後，再正式處理全部資料。

 

常見問題

免費方案可以使用 lihi API 嗎？

不行。Free 方案無法取得 API 金鑰。基本 API 需 Starter 以上方案，商用 API 需 Business 以上方案。

基本 API 和商用 API 有什麼不同？

基本 API 可建立短網址，並可透過簡訊 API 發送簡訊與 OTP；商用 API 另外提供查詢、修改、刪除單一短網址，批次查詢、建立、刪除，以及依標籤與建立日期查詢短網址。

基本 API 和 Google 試算表用的是同一組金鑰嗎？

是。基本 API 與 Google 試算表串接共用同一組 API 金鑰。

API 金鑰外洩怎麼辦？

商用 API 可在後台點擊「重新產生」，舊金鑰會立即失效，原本串接的系統需同步更新新金鑰；基本 API 請聯繫客服協助。

簡訊與 OTP API 也是用 API 金鑰嗎？

不是。簡訊與 OTP API 使用 Verify Token，需先開通 lihi 簡訊功能後再申請。詳細流程可參考 lihiSMS OTP API 串接教學。