Token API文档

    更新时间:2024-03-29 15:30:00

    1. 授权参数

    Authorization: Bearer {API TOKEN}

    其中 {API TOKEN} 是你在控制台创建的API令牌。该 token 在后续的 API 请求中用于身份验证。

    2. API 端点

    2.1 获取我的令牌

    此接口用于获取当前用户的所有 API 令牌。

    GET https://spacemapper.cn/cgi/token/list

    请求参数

    参数名 类型 说明
    直接通过Authorization头部进行身份验证

    响应示例

    {
        "code": 0,
        "data": [
          {
            "id": 1300822721822721,
            "createTime": "2025-02-26T15:06:06+0800",
            "userId": 60,
            "token": "mlc9ygOzdcgXiGv_7c2kNj2Vt....",
            "expires": "2025-08-25T15:06:06+0800"
          }
        ]
      }

    字段描述

    字段 类型 说明
    code 整数 响应状态码,0表示成功
    data 数组 令牌列表
    id 长整型 令牌唯一ID
    createTime 字符串 ISO 8601格式创建时间
    userId 长整型 关联用户ID
    token 字符串 API令牌
    expires 字符串 ISO 8601格式过期时间

    2.2 创建令牌

    此接口用于为当前用户创建一个新的 API 令牌。

    POST https://spacemapper.cn/cgi/token/create

    请求参数

    参数名 类型 说明
    直接通过Authorization头部进行身份验证

    响应示例

    {
        "code": 0,
        "data": {
          "id": 124,
          "createTime": "2025-02-26T15:06:06+0800",
          "userId": 60,
          "token": "newToken123456",
          "expires": "2025-08-25T15:06:06+0800"
        }
      }

    字段描述

    字段 类型 说明
    code 整数 响应状态码,0表示成功
    data 对象 新令牌详细信息
    id 长整型 令牌唯一ID
    createTime 字符串 ISO 8601格式创建时间
    userId 长整型 关联用户ID
    token 字符串 新生成的API令牌
    expires 字符串 ISO 8601格式过期时间

    2.3 令牌检查

    此接口用于检查当前用户的令牌是否需要更新。

    POST https://spacemapper.cn/cgi/token/check

    请求参数

    参数名 类型 说明
    直接通过Authorization头部进行身份验证

    响应示例

    {
        "code": 0,
        "data": {
          "shouldBeUpdated": 1,
          "expired": 0
        }
      }

    字段描述

    字段 类型 说明
    code 整数 响应状态码,0表示成功
    data.shouldBeUpdated 整数 1需要更新,0不需要
    data.expired 整数 1已过期,0未过期

    2.4 删除令牌

    此接口用于删除指定的 API 令牌。

    POST https://spacemapper.cn/cgi/token/delete

    请求参数

    参数名 类型 说明
    tokenId 长整型 要删除的 API 令牌的 ID

    响应示例

    {
        "code": 0,
        "data": 1
      }

    3. 更新机制

    1. 每个 token 的有效期默认为 180 天。建议每周进行检查
    2. 当调用 /token/check 返回 shouldBeUpdated: 1 时, 表示需要创建新令牌。遇到 401 状态码需重新手动创建
    3. 更新时调用 /token/create 并使用新令牌
    7 * 24小时服务图标

    7 * 24

    多渠道服务支持

    专业服务图标

    专业服务

    云业务全流程支持

    值得信赖图标

    值得信赖

    可以依赖的合作伙伴

    专属贴身服务图标

    专属贴身服务

    1V1贴身服务,专属保障

    建议反馈图标

    建议反馈

    优化建议反馈