跳到主要内容

获取 Access Token

更新时间 2025/02/22 07:19:43

认证机制​

在现代网络应用中，保障数据的安全传输和对敏感信息的严格访问控制至关重要。我们设计了一套鉴权机制，它通过一个标准化流程使第三方应用能够安全地获取所需的访问权限，无需处理用户登录凭证。这样既保护了用户的账号信息，同时也简化了外部开发者的集成工作。

Access Token​

在画布API中，Access Token 充当了API请求中的“密钥”，用以验证和授权用户的身份，让您能够执行诸如创建、检索、更新或删除资源等操作。

注意:

  • 本文描述的 Access Token 仅适用于英飞 REST 服务鉴权机制，与画布 WebSDK 初始化 Token，及画布辅助 SDK 鉴权 Token 在使用场景及生成方式上均有不同，请注意区分并避免混用。
  • 我们推荐仅在服务端使用 Access Tokens 来调用 API，以此来降低应用凭据及 Access Token 泄露的可能性。
  • Access Token 具有一定的有效期。一旦过期，您需要重新获取新的 Token 以继续使用 API。

如何获取 Access Token​

  1. 在请求 Access Token 之前，您首先需要于我们的开发者控制台中开通画布服务，具体流程可以参考文档。
  2. 创建应用后，您可以在我们的管理台内获取到应用的凭据 appId 和密钥 appSecret。

在获取到凭据后，您即可调用我们的接口来获取 Access Token。

请求路径​

https://developer.infi.cn/infi/api/v1/auth/tokens

请求参数​

字段
类型
描述
必填
appId
string
应用 appId，可以在控制台中获取
是
appSecret
string
应用 appSecret，可以在控制台中获取
是
expiresIn
number
访问令牌有效时间，单位为秒，默认一小时
否

成功请求情况​

如果请求成功，则 http 状态码为 200，返回数据内会包含：

字段
类型
描述
accessToken
string
应用 Access Token
expiresIn
number
Token 过期时间

请求成功数据示例：

{
    "accessToken": "YOUR_ACCESS_TOKEN",
    "expiresIn": 3600
}

成功失败情况​

如果请求失败，则 http 状态码为 400/401, 请您根据反馈的错误消息检验数据并重新发送请求。请求失败包体示例：

// appId 非法情况
{
  "code": "Bad Request",
  "message": "App XXX is invalid",
  "status": 400,
  "type": "error"
}

// appSecret 非法情况
{
  "code": "Not Authorized",
  "message": "appSecret is incorrect",
  "status": 401,
  "type": "error"
}