Authentication
使用 Meshy API 需要 authentication。本指南将向你展示如何创建账户和 API keys。
API Keys
创建 Meshy 账户
Meshy API 要求你拥有一个 Meshy 账户来创建和管理 API keys。如果在没有 API key 的情况下向 API 发起请求,API 将返回一个无效凭据错误。
你可以访问 Meshy 官方网站
创建 API Keys
创建 Meshy 账户后,你可以访问 API 设置页面
你可以为不同的用途创建多个 API keys。例如,你可以为你的 iOS 应用创建一个 API key,为 Web App 创建另一个。每个 API key 的使用情况都是分别追踪的,你可以随时撤销它们。
要创建 API key,点击 API 页面上的 Create API Key 按钮,然后为你的 API key 输入一个名称。
创建 API key 后,系统会向你显示该 API key 的值。你可以复制该 API key 的值并将其存储在安全的位置。
你之后将无法再次看到此 API key 的值。
使用 API Keys
创建 API key 后,你可以使用它来对你向
Meshy API 发起的请求进行 authentication。你可以在 Authorization 头部中传递你的 API key,
下面展示了一个示例头部。
{
"Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}
在以编程方式与 Meshy API 交互时,头部值中的 Bearer 前缀是必须的。
你可以在 IETF RFC 6750
Security
我们在 Meshy 非常重视安全性,并努力确保 Meshy API 的安全。我们希望你的数据和你用户的数据在我们这里是安全的。 以下是一些高层准则,帮助你在使用 Meshy API 时保护数据和请求的安全,但也请确保遵循 你的团队或工作场所所实行的准则。
传输层安全
虽然你的数据一旦存储在 Meshy 中就会在静态时被加密,但 Meshy API 还使用并强制采用 TLS301 Moved Permanently 状态码。尽管不推荐,
但在某些情况下,如果你必须使用 HTTP 通信,你需要明确告知你的 HTTP 客户端跟随 HTTP 到 HTTPS 的重定向。以下是一些示例:
Follow HTTP to HTTPS redirections
# use `-L` to follow HTTP to HTTPS redirections
curl -L -X 'POST' \
https://api.meshy.ai/openapi/v1/text-to-texture
API Key 安全性
请注意,即使是 Meshy 团队成员也无法为你查看或恢复已撤销的 API keys!
一旦生成,API keys 将不再在控制面板中可见,因此请下载并妥善、安全地保管它,因为任何获取该 API key 的人都可以 以你的身份与 Meshy API 通信。如果你认为你的 API key 已被泄露,你可以随时在控制面板中撤销它, 一旦撤销,它将不再有效。
安全披露
如果你认为自己发现了 Meshy API 中的安全问题,请 与我们联系