> For the complete documentation index, see [llms.txt](https://docs.apismart.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apismart.ai/documentation/zh-tw/huan-ying-shi-yong-apismart/api-jin-yue/bao-hu-nin-de-api-jin-yue.md).

# 保護您的 API 金鑰

了解如何保護您的 ApiSmart API 金鑰、避免意外外洩，以及在金鑰遭到入侵時迅速應對。

您的 API 金鑰是一種敏感憑證，用於驗證對 ApiSmart API 的請求。

任何擁有有效金鑰存取權的人，都可能使用您帳戶可用的權限發出 API 請求。請妥善保護您的 API 金鑰，並移除或停用任何可能已外洩的金鑰。

### 🔐 將 API 金鑰保密

請將每個 API 金鑰視為密碼。

請勿：

* 公開分享 API 金鑰
* 將 API 金鑰提交到公開的 Git 儲存庫
* 將 API 金鑰貼到公開的程式碼範例中
* 在螢幕截圖中包含完整的 API 金鑰
* 將 API 金鑰儲存在可公開存取的檔案中
* 在瀏覽器端或其他不受信任的用戶端程式碼中暴露 API 金鑰
* 在日誌或錯誤訊息中包含完整的 API 金鑰

只向需要它的系統和應用程式提供 API 金鑰。

### 📦 將金鑰存放在原始碼之外

避免將 API 金鑰直接硬編碼在應用程式中。

請改用環境變數或安全的密鑰管理系統。

例如：

```bash
export APISMART_API_KEY="your-api-key"
```

接著，您的應用程式就可以從環境中讀取該值，而不是將憑證儲存在原始碼中。

#### Python

```python
import os

api_key = os.getenv("APISMART_API_KEY")
```

#### JavaScript

```javascript
const apiKey = process.env.APISMART_API_KEY;
```

請確保包含密鑰的檔案，例如 `.env`，已從版本控制中排除。

### 🧩 為不同環境使用獨立金鑰

在可行的情況下，為不同的應用程式或環境使用獨立的 API 金鑰。

例如：

* 開發
* 測試
* 預備環境
* 正式環境

這樣更容易識別使用情況，並在不影響您帳戶連結的所有應用程式的前提下停用特定憑證。

請使用具描述性的金鑰名稱，這樣您就能快速了解每個金鑰的使用位置。

### 🖥️ 將 API 金鑰保留在受信任的伺服器上

對於網頁應用程式，API 金鑰通常應保留在後端或其他受信任的伺服器環境中。

避免將機密 API 金鑰直接嵌入到：

* 瀏覽器 JavaScript
* 公開的前端原始碼
* 行動應用程式套件
* 公開的設定檔

如果使用者可以檢查應用程式並擷取金鑰，則應將該憑證視為已外洩。

### 📝 避免記錄完整 API 金鑰

應用程式日誌可能被開發人員、監控工具、支援系統或其他服務存取。

請勿在日誌中記錄完整的 API 金鑰。

如果您需要識別使用的是哪個金鑰，請只記錄安全的識別碼或有限的前綴，而非完整憑證。

ApiSmart Console 也可以協助您在不必要地暴露完整憑證的情況下，識別並管理現有的 API 金鑰。

### 🔄 定期檢查您的 API 金鑰

請定期檢視您帳戶中的 API 金鑰。

請確認：

* 每個金鑰仍屬於啟用中的應用程式
* 金鑰名稱能清楚標示其用途
* 舊的開發或測試金鑰仍然需要
* 意外出現或未使用的金鑰應停用或刪除

移除未使用的憑證可降低不必要的暴露。

### 🚨 如果 API 金鑰已外洩

如果您認為某個 API 金鑰已遭洩漏，或被不應擁有它的人存取，請盡快停止使用該金鑰。

建議步驟：

1. **停用已外洩的 API 金鑰**
2. **建立替代的 API 金鑰**
3. **更新您的應用程式以使用新金鑰**
4. **驗證應用程式可使用替代金鑰正常運作**
5. **當已外洩的金鑰不再需要時，將其刪除**
6. **檢視近期 API 使用情況是否有異常活動**

不要繼續使用可能已遭入侵的憑證。

### ⚠️ 驗證錯誤

如果金鑰已被停用、刪除，或因其他原因無效，API 請求可能會回傳：

`401 invalid_api_key`

請確認應用程式使用的是有效的 API 金鑰，且驗證標頭格式正確：

```http
Authorization: Bearer <your-api-key>
```

A `403 model_not_allowed` 回應與驗證失敗不同。這表示所選模型目前無法供此 API 金鑰或帳戶使用。

如需更多關於 API 錯誤的資訊，請參閱 [**HTTP 狀態碼與 API 錯誤**](https://docs.apismart.ai/documentation/zh-tw/yi-nan-pai-jie/http-zhuang-tai-ma-yu-api-cuo-wu.md)。\
有關模型存取問題，請參閱 [**模型與模型 ID**](https://docs.apismart.ai/documentation/zh-tw/mo-xing-yu-jia-ge/mo-xing-yu-mo-xing-id.md).

### ✅ API 金鑰安全檢查清單

在部署應用程式之前，請確認：

* 您的 API 金鑰未硬編碼到公開原始碼中
* 密鑰檔案已從版本控制中排除
* 正式環境憑證儲存在安全環境中
* 開發與正式環境在適當情況下使用不同的 API 金鑰
* 完整的 API 金鑰未寫入日誌中
* 公開的用戶端應用程式無法存取該憑證
* 未使用的 API 金鑰已停用或刪除
* 外洩的金鑰已立即更換

### ➡️ 下一步

繼續進行：

* [**建立並管理 API 金鑰**](https://docs.apismart.ai/documentation/zh-tw/huan-ying-shi-yong-apismart/api-jin-yue/jian-li-bing-guan-li-api-jin-yue.md) — 建立、編輯、停用和刪除 API 金鑰
* [**快速開始**](https://docs.apismart.ai/documentation/zh-tw/huan-ying-shi-yong-apismart/kuai-su-kai-shi.md) — 發出您的第一個 API 請求
* [**API 基礎**](https://docs.apismart.ai/documentation/zh-tw/api-zhi-nan/api-ji-chu.md) — 了解常見的 API 驗證與請求慣例
