Authentication

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


API Keys

建立 Meshy 帳戶

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

你可以透過造訪 Meshy 官方網站 並註冊來建立 Meshy 帳戶。

建立 API Keys

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

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

你還可以為任意金鑰設定每月 credit 限額,無論你帳戶的整體使用量如何,都可以限制該金鑰的支出上限——這對於限制交給承包商或特定環境使用的金鑰非常有用。

建立 API Key 對話框,其中包含一個可選的每月 credit 限額欄位

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

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

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

使用 API Keys

建立 API 金鑰後,你可以使用它對你向 Meshy API 發出的請求進行身份驗證。你可以在 Authorization 請求標頭中傳遞你的 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 的重新導向。以下是一些範例:

遵循從 HTTP 到 HTTPS 的重新導向

# use `-L` to follow HTTP to HTTPS redirections
curl -L -X 'POST' \
  https://api.meshy.ai/openapi/v1/text-to-texture

API Key 安全

API 金鑰一旦產生,將不再在儀表板中可見,因此請下載並妥善、安全地保管它,因為任何取得它的人都可以 以你的名義與 Meshy API 通訊。如果你認為你的 API 金鑰已經洩漏,你可以隨時在儀表板中將其撤銷, 一旦撤銷,它將不再有效。

安全揭露

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