小红书 API
  1. 开发文档
小红书 API
  • 开发文档
    • 应用开发
    • 新手指南
    • 应用测试
    • 授权流程(自研)
    • 授权流程(软件服务商)
    • 签名算法
    • 系统参数说明
    • 应用消息推送
    • SDK 使用说明
    • 发布服务
  • API 调用场景
    • 商品基础介绍
    • 订单基础介绍
    • 跨境订单介绍
    • 订单接入方案
    • 售后接入说明
  • 数据加解密
    • 数据加密对接方案
    • 加密算法介绍
  • 电子面单
    • 电子面单对接说明
    • 电子面单打印组件协议
  • 规则中心
    • 小红书开放平台开发者协议
    • 数据安全承诺函
    • 服务市场上架审核标准
    • 开发者角色说明
    • 小红书服务市场服务协议(服务商版)
    • 小红书服务市场管理规范
    • 企业管理类目管理规则
    • 商品管理类目管理规则
    • 订单管理类目管理规则
    • 内容工具类目管理规则
    • 小红书服务市场保证金要求
  • 公共 API
    • 批量获取发货时间规则
    • 获取地址信息(新)
    • 获取商家地址库
    • 获取分类列表
    • 由末级分类获取规格(新)
    • 由末级分类获取属性
    • 由属性获取属性值
    • 获取快递公司信息
    • 获取物流方案列表
    • 运费模版列表
    • 运费模版详情
    • 获取品牌信息
    • 获取物流模式列表
    • 获取地址信息
    • 获取老版本商家授权信息
    • cc资质检查
    • 商品标题类目预测
    • 由末级分类获取规格(旧)
  • 订单 API
    • 带货达人侧详情查询
    • 查询月度结算单下载地址
    • 订单列表
    • 订单详情
    • 订单收件人信息
    • 修改订单备注
    • 订单发货
    • 修改快递单号
    • 订单物流轨迹
    • 海关申报信息
    • 获取取消申请列表(即将下线)
    • 取消申请审核(即将下线)
    • 跨境清关支持口岸
    • 跨境重推支付单
    • 跨境商品备案信息同步
    • 跨境商品备案信息查询
    • 小包批次创建
    • 开票列表查询
    • 开票结果回传(正向蓝票开具)
    • 发票冲红(逆向冲红)
    • 批量解密
    • 批量脱敏
    • 批量获取索引串
  • 售后 API
    • 售后换货确认收货并发货
    • 获取售后列表
    • 售后详情
    • 售后审核(新)
    • 售后确认收货(新)
  • 商品 API
    • 商品列表基础版
    • 商品列表完整版(新)
    • 更新物流方案
    • 商品上下架
    • 创建ITEM
    • 更新TEM
    • 删除ITEM
    • 创建SKU
    • 更新SKU
    • 删除SKU
    • 查询Item列表
    • 获取ITEM详情
    • 修改价格
    • 修改商品主图、主图视频
    • 修改规格图
  • 库存 API
    • 获取商品库存
    • 同步库存
    • 增减库存
  • 素材中心 API
    • 素材列表
    • 上传素材
    • 修改素材
    • 删除素材
  • 消息文档
    • 商品新建
    • 商品上下架
    • 商品审核驳回
    • 商品删除
  • 物流 API
    • 查询电子面单订购关系
    • 查询电子面单模板列表
    • 批量取号
    • 更新面单
    • 取消面单
    • 查询面单
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  • 素材中心 API
  1. 开发文档

授权流程(软件服务商)

1.获取授权码(code);#

组装格式:
https://ark.xiaohongshu.com/ark/authorization?appId=xxx&redirectUri=xxx&state=xxx
组装示例:
https://ark.xiaohongshu.com/ark/authorization?appId=4b6*******672e4c9a&redirectUri=http%3A%2F%2Fwww.xiaohongshu.com&state=1234
授权页组装参数如下
参数名称是否必选示例值参数释义
appId必选-第三方使用小红书开放平台的appId
redirectUri必选http%3A%2F%2Fwww.xiaohongshu.com授权后回调地址字段值,在用户完成授权后,code值将回调至该地址中
state可选1234标识位,返回时将原值返回,可用于标识商家
引导用户跳转到授权页面后会判断当前商家主账号是否登录,若登录则点击直接授权,若未登录则登录后再跳转授权。

注意事项:
        1)店铺类型及账号限制:只允许店铺主账号才可以授权成功。
        2)允许重复授权,在code有效期内重复授权获取到到code不变,在上一次code失效后重复授权会导致之前所有生成的code,accessToken,refreshToken失效。
        3)允许取消授权:授权应用后,可以在账号应用管理处查看授权应用信息,并取消授权

用户完成「授权登录」后,授权码code将返回到回调地址中,以参数code形式组装至回调地址中,应用可以获取并使用该code去换取accessToken。

注意事项:code有效期10分钟,10分钟后code过期则需要重新授权,短时间内多次使用code换取accessToken是一样的,返回数据展示如下
返回code:
https://{回调地址redirectUri}/?code=74afa4f59c404***089e9db87797d6cc&state=1234

2.获取访问令牌(accessToken)#

HTTP:
https://ark.xiaohongshu.com/ark/open_api/v3/common_controller
body参数说明
参数名称是否必选示例值参数释义
appId必选21d600****be8de0第三方使用小红书开放平台的appId
version必选2.0网关版本判定参数目前授权流程使用2.0
sign必选867105****e77ff0bafb0输入参数的签名结果,签名方法参见sign签名算法
timestamp必选1612239430773接口调用时的时间戳
method必选oauth.getAccessToken调用具体方法
方法参数说明
参数名称是否必选示例值参数释义
code必选code-9e2*****f3b32授权code
请求示例
{
    "sign":"6a76602***68400",
    "appId":"21d***be8de0",
    "timestamp":"161***379",
    "version":"2.0",
    "method":"oauth.getAccessToken",
    "code":"code-9e28279***e6035dc686e0-7aaea***841f3b32"
    }
响应参数说明
参数名称示例值参数释义
accessToken21d600****be8de0访问令牌
accessTokenExpiresAt1612239430773访问令牌过期时间(ms)
refreshToken867105****e77ff0bafb0刷新令牌
refreshTokenExpiresAt1612239430773刷新令牌过期时间(ms)
sellerId5a151****ee832商家编码
sellerName开放平台测试店1专卖店商家名
响应示例
{
    "error_code": 0,
    "data": {
        "accessToken": "token-2d22cd***3c1b55bc7-e83e919***a3504b398",
        "accessTokenExpiresAt": 1613807389260,
        "refreshToken": "refresh-72df8ba***7e1387407ac-944badaf***268294df5ae1",
        "refreshTokenExpiresAt": 1616312989263,
        "sellerId": 5a1***76ee832,
        "sellerName": "开放平台测试店1专卖店"
    },
    "success": true
}

注意事项:
        1)accessToken有效期为7天,refreshToken有效时间为14天
        2)accessToken未过期且剩余有效时间大于30分钟,使用refreshToken进行刷新后accessToken和refreshToken均不会刷新
        3)accessToken未过期且剩余有效时间小于30分钟,使用refreshToken进行刷新后会得到新的accessToken和refreshToken,且旧accessToken有效期为5分钟
        4)accessToken过期后使用refreshToken进行刷新后会得到新的accessToken和refreshToken
        5)refreshToken过期后需要通过用户重新授权
        6)获取accessToken和刷新accessToken的参数均通过body传输
        7)后续所有业务接口的url和获取token的url保持一致

3.刷新访问令牌#

HTTP:
https://ark.xiaohongshu.com/ark/open_api/v3/common_controller
公共参数说明
参数名称是否必选示例值参数释义
appId必选21d600****be8de0第三方使用小红书开放平台的appId
version必选2.0网关版本判定参数目前授权流程使用2.0
sign必选867105****e77ff0bafb0输入参数的签名结果,签名方法参见sign签名算法
timestamp必选1612239430773接口调用时的时间戳
method必选oauth.refreshToken调用具体方法
方法参数说明
参数名称是否必选示例值参数释义
refreshToken必选refresh-abe******9c2b9f9用于刷新的refreshToken
请求示例
{
    "sign":"6a76602***46ee68400",
    "appId":"21d6***8de0",
    "timestamp":"161***8379",
    "version":"2.0",
    "method":"oauth.refreshToken",
    "refreshToken":"refresh-06ca049***b77ac4493697-3251618c7***ebfffd7e"
    }
响应参数说明
参数名称示例值参数释义
accessToken21d600****be8de0刷新后的访问令牌
accessTokenExpiresAt1612239430773访问令牌过期时间(ms)
refreshToken867105****e77ff0bafb0刷新后的刷新令牌
refreshTokenExpiresAt1612239430773刷新令牌过期时间(ms)
sellerId5a151****ee832商家编码
sellerName开放平台测试店1专卖店商家名
响应示例
{
    "error_code": 0,
    "data": {
        "accessToken": "token-e643e958****da68398a-572e65****24c3f922",
        "accessTokenExpiresAt": 1613807628007,
        "refreshToken": "refresh-72df8ba****e1387407ac-944bad****94df5ae1",
        "refreshTokenExpiresAt": 1616312989262,
        "sellerId": 5a151****12e76ee832,
        "sellerName": "开放平台测试店1专卖店"
    },
    "success": true
}

注意事项:
        1)accessToken有效期为7天,refreshToken有效时间为14天
        2)accessToken未过期且剩余有效时间大于30分钟,使用refreshToken进行刷新后accessToken和refreshToken均不会刷新
        3)accessToken未过期且剩余有效时间小于30分钟,使用refreshToken进行刷新后会得到新的accessToken和refreshToken,且旧accessToken有效期变为5分钟
        4)accessToken过期后使用refreshToken进行刷新后会得到新的accessToken和refreshToken
        5)refreshToken过期后需要通过用户重新授权
        6)获取accessToken和刷新accessToken的参数均通过body传输
        7)后续所有业务接口的url和刷新token的url保持一致

【小红书】API开发者 微信交流群

用微信扫右侧二维码,加入【小红书】API开发者 交流群,互助沟通

扫码加入交流群
上一页
授权流程(自研)
下一页
签名算法
Built with