Authentication

使用 Meshy API 需要進行身份驗證。本指南將向你展示如何建立帳戶和 API 金鑰。

API Keys

建立 Meshy 帳戶

Meshy API 要求你擁有一個 Meshy 帳戶才能建立和管理 API 金鑰。如果在沒有 API 金鑰的情況下向 API 發出請求，API 將回傳一個無效憑證的錯誤。

你可以造訪 Meshy 官方網站 並註冊，來建立一個 Meshy 帳戶。

建立 API Key

建立 Meshy 帳戶後，你可以在 開發者平台 的 API Keys 頁面上建立 API 金鑰。

你可以為不同的用途建立多個 API 金鑰。例如，你可以為你的 iOS 應用程式建立一個 API 金鑰，為你的網頁應用程式建立另一個。每個 API 金鑰的使用情況都會單獨追蹤，你可以隨時撤銷它們。

你還可以為任意一個金鑰設定每月 credit 限額，限制其無論你帳戶整體使用量如何都只能消耗這麼多——這對於限制你交給承包商或特定環境使用的金鑰非常有用。

要建立 API 金鑰，請點擊 API 頁面上的 Create API Key 按鈕，然後為你的 API 金鑰輸入一個名稱。

建立 API 金鑰後，系統會顯示該 API 金鑰的值。你可以複製這個 API 金鑰的值並將其儲存在安全的位置。

你將無法再次看到此 API 金鑰的值。

使用 API Key

建立 API 金鑰後，你可以使用它來對你向 Meshy API 發出的請求進行身份驗證。你可以透過 Authorization 請求標頭將你的 API 金鑰傳遞給 API，下面是一個請求標頭的範例。

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Security

我們在 Meshy 非常重視安全，並努力確保 Meshy API 的安全性。我們希望你的資料以及你的使用者的資料在我們這裡是安全的。 以下是一些高層次的指導原則，可以幫助你在使用 Meshy API 時確保資料和請求的安全，但也請務必遵循你的團隊或工作場所所採用的相關規範。

傳輸層安全

雖然你的資料一旦儲存在 Meshy 中就會在靜態儲存時被加密，但 Meshy API 還使用並強制執行 TLS， 以加密傳輸中的資料。這意味著所有發往和來自 Meshy API 的請求都透過 HTTPS 傳送，任何透過 HTTP 發出的請求都將收到 301 Moved Permanently 狀態碼。雖然不建議這樣做， 但在某些情況下，如果你必須使用 HTTP 通訊，你需要明確地告訴你的 HTTP 用戶端遵循從 HTTP 到 HTTPS 的重新導向。以下是一些範例：

# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

重新導向僅適用於 GET 請求：HTTP 用戶端在重新導向 POST 請求時會將其作為不帶請求主體的 GET 請求重新傳送，因此在建立任務時請始終直接呼叫 https://。

API Key 安全

API 金鑰一旦產生，就不再在控制面板中可見，因此請下載並妥善安全地保管它，因為任何取得它的人都可以用它代表你與 Meshy API 進行通訊。如果你認為你的 API 金鑰已經洩露，你可以隨時在控制面板中將其撤銷， 一旦撤銷，它將不再有效。

安全問題揭露

如果你認為自己發現了 Meshy API 中的安全問題，請與我們聯繫。我們感謝你負責任的揭露， 並將盡一切努力肯定你的貢獻。