欢迎来到 Quote3D 文档!⏳

身份验证

Quote3D 通过 API 令牌保护 API 端点。外部请求请以 https://api.quote3d.com/v2 开头,并以 Authorization: Bearer YOUR_TOKEN_HERE 或 X-API-Token: YOUR_TOKEN_HERE 的形式发送相同的令牌。

身份验证工作原理

  1. 注册并登录您的 Quote3D 账户。
  2. 从您的仪表板的“Tokens”选项卡下生成一个 API token。
  3. 在您的 API 请求中包含 token。支持 Authorization: Bearer,也接受 X-API-Token:
    Authorization: Bearer YOUR_TOKEN_HERE
  4. 服务器会验证您的令牌,如果令牌有效且未过期,则授予访问权限。

什么是 JWT?

Quote3D 令牌是 bearer-style API 凭证。客户端应将其视为不透明的密钥,并避免依赖于令牌的内部结构。

JWT 由三个部分组成:

  1. Header(头部):指定签名算法和令牌类型。
  2. Payload(有效载荷):包含用户数据和声明(如用户 ID、电子邮件和过期时间)。
  3. Signature(签名):验证令牌是否被篡改。

JWT 的样子如下:

<base64url-encoded header>.<base64url-encoded payload>.<base64url-encoded signature>

对于集成,重要的规则很简单:安全地存储令牌,在每个请求中发送它,并避免在客户端代码中解析或暴露它,除非集成明确需要客户端令牌。

示例:使用您的令牌

以下是如何使用 curl 调用您的令牌。请始终使用一种身份验证标头样式。

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.quote3d.com/v2/user

或者在 API Playground 中,将您的令牌粘贴到授权模态框(锁图标)中以验证您的会话。您还可以在自定义集成中使用 X-API-Token 标头(如果该标头更适合)。

请妥善保管您的令牌!像对待密码一样对待它——切勿分享或在公共代码仓库中暴露它。