API 接口文档

通过简单的 HTTP 请求，将闪邮箱的邮箱服务集成到您的工作流中。支持余额查询、商品采购、邮件读取等全链路操作。

API Key

登录后查看 API Key

通过 Query 参数 clientKey 调用 OpenAPI

接口列表

/open/mail/latest-message

查询余额和 VIP 信息

返回当前 API Key 对应用户的余额和 VIP 信息

请求地址

GETURL

GET https://api.shanyouxiang.com/open/user/balance

请求参数

clientKey

是query

string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

参数	类型	必须	位置	说明
clientKey	string	是	query	当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

测试接口

参数输入

clientKey*query / string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

点击发送请求并查看返回结果

请求示例

cURL

curl -X GET "https://api.shanyouxiang.com/open/user/balance?clientKey={clientKey}"

文档响应示例（非实时数据）

{
  "code": 0,
  "success": true,
  "message": "",
  "data": {
    "email": "",
    "balance": 0,
    "vipLevel": 0,
    "vipName": "",
    "discountRate": 0,
    "totalDeposit": 0
  },
  "requestId": ""
}

查询商品列表和库存

无需 clientKey 鉴权，productId 不传时返回全部可见商品库存，传入 productId 时返回包含指定商品库存的列表

请求地址

GETURL

GET https://api.shanyouxiang.com/open/product/stock

请求参数

productId

否query

number

商品 ID，不传时查询全部可见商品库存；可在商品页的商品卡片处复制获取

参数	类型	必须	位置	说明
productId	number	否	query	商品 ID，不传时查询全部可见商品库存；可在商品页的商品卡片处复制获取

测试接口

参数输入

productIdquery / number

商品 ID，不传时查询全部可见商品库存；可在商品页的商品卡片处复制获取

点击发送请求并查看返回结果

请求示例

cURL

curl -X GET "https://api.shanyouxiang.com/open/product/stock?productId={productId}"

文档响应示例（非实时数据）

{
  "code": 0,
  "success": true,
  "message": "",
  "data": [
    {
      "productId": 0,
      "name": "",
      "stock": 0,
      "price": 0
    }
  ],
  "requestId": ""
}

购买邮箱账号

按 productId 和数量购买邮箱账号

请求地址

GETURL

GET https://api.shanyouxiang.com/open/product/buy

请求参数

clientKey

是query

string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

productId

是query

number

商品 ID，可在商品页的商品卡片处复制获取

quantity

是query

integer

购买数量，至少为 1

参数	类型	必须	位置	说明
clientKey	string	是	query	当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权
productId	number	是	query	商品 ID，可在商品页的商品卡片处复制获取
quantity	integer	是	query	购买数量，至少为 1

测试接口

参数输入

clientKey*query / string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

productId*query / number

商品 ID，可在商品页的商品卡片处复制获取

quantity*query / integer

购买数量，至少为 1

点击发送请求并查看返回结果

请求示例

cURL

curl -X GET "https://api.shanyouxiang.com/open/product/buy?clientKey={clientKey}&productId={productId}&quantity={quantity}"

文档响应示例（非实时数据）

{
  "code": 0,
  "success": true,
  "message": "",
  "data": {
    "accounts": [
      ""
    ],
    "quantity": 0,
    "totalAmount": 0,
    "balance": 0
  },
  "requestId": ""
}

获取指定邮箱账号的最新一封邮件

按账号凭据、邮箱文件夹和可选 start_timestamp 查询最新一封邮件；暂时只支持获取微软邮箱的邮件

请求地址

GETURL

GET https://api.shanyouxiang.com/open/mail/latest-message

请求参数

clientKey

是query

string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

account

是query

string

邮箱账号完整凭据，格式为 email:password:refreshToken:clientId

folder

是query

string

邮箱文件夹，仅支持 inbox（收件箱）或 junkemail（垃圾邮件）

start_timestamp

否query

number

起始接收时间戳（Unix 秒级时间戳），仅返回该时间之后收到的邮件；query 参数名为 start_timestamp

参数	类型	必须	位置	说明
clientKey	string	是	query	当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权
account	string	是	query	邮箱账号完整凭据，格式为 email:password:refreshToken:clientId
folder	string	是	query	邮箱文件夹，仅支持 inbox（收件箱）或 junkemail（垃圾邮件）
start_timestamp	number	否	query	起始接收时间戳（Unix 秒级时间戳），仅返回该时间之后收到的邮件；query 参数名为 start_timestamp

测试接口

参数输入

clientKey*query / string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

account*query / string

邮箱账号完整凭据，格式为 email:password:refreshToken:clientId

folder*query / string

邮箱文件夹，仅支持 inbox（收件箱）或 junkemail（垃圾邮件）

start_timestampquery / number

起始接收时间戳（Unix 秒级时间戳），仅返回该时间之后收到的邮件；query 参数名为 start_timestamp

点击发送请求并查看返回结果

请求示例

cURL

curl -X GET "https://api.shanyouxiang.com/open/mail/latest-message?clientKey={clientKey}&account={account}&folder={folder}&start_timestamp={start_timestamp}"

文档响应示例（非实时数据）

{
  "code": 0,
  "success": true,
  "message": "",
  "data": {
    "from": "",
    "subject": "",
    "html": "",
    "text": "",
    "receivedAt": ""
  },
  "requestId": ""
}

查询订单列表

按页码、每页条数和可选订单状态查询当前用户的 Web 端购买订单；暂不开放 API 购买订单查询

请求地址

GETURL

GET https://api.shanyouxiang.com/open/order/list

请求参数

clientKey

是query

string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

pageNum

否query

integer

页码，从 1 开始；不传默认查询第 1 页，小于 1 时按参数错误拒绝

pageSize

否query

integer

每页条数；不传默认 10，小于 1 或大于 100 时按参数错误拒绝

status

否query

integer

按订单状态筛选；不传则查询全部状态。0=待处理，1=处理中，2=已完成，3=部分完成，4=失败，5=已退款

参数	类型	必须	位置	说明
clientKey	string	是	query	当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权
pageNum	integer	否	query	页码，从 1 开始；不传默认查询第 1 页，小于 1 时按参数错误拒绝
pageSize	integer	否	query	每页条数；不传默认 10，小于 1 或大于 100 时按参数错误拒绝
status	integer	否	query	按订单状态筛选；不传则查询全部状态。0=待处理，1=处理中，2=已完成，3=部分完成，4=失败，5=已退款

测试接口

参数输入

clientKey*query / string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

pageNumquery / integer

页码，从 1 开始；不传默认查询第 1 页，小于 1 时按参数错误拒绝

pageSizequery / integer

每页条数；不传默认 10，小于 1 或大于 100 时按参数错误拒绝

statusquery / integer

按订单状态筛选；不传则查询全部状态。0=待处理，1=处理中，2=已完成，3=部分完成，4=失败，5=已退款

点击发送请求并查看返回结果

请求示例

cURL

curl -X GET "https://api.shanyouxiang.com/open/order/list?clientKey={clientKey}&pageNum={pageNum}&pageSize={pageSize}&status={status}"

文档响应示例（非实时数据）

{
  "code": 0,
  "success": true,
  "message": "",
  "data": [
    {
      "orderNo": "",
      "productId": 0,
      "productName": "",
      "quantity": 0,
      "unitPrice": 0,
      "totalAmount": 0,
      "status": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss"
    }
  ],
  "requestId": ""
}

查询订单详情

按订单号查询当前用户的 Web 端购买订单详情；暂不开放 API 购买订单查询

请求地址

GETURL

GET https://api.shanyouxiang.com/open/order/info

请求参数

clientKey

是query

string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

orderNo

是query

string

订单号

参数	类型	必须	位置	说明
clientKey	string	是	query	当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权
orderNo	string	是	query	订单号

测试接口

参数输入

clientKey*query / string

当前用户的 API Key，作为 query 参数传入，用于开放接口鉴权

orderNo*query / string

订单号

点击发送请求并查看返回结果

请求示例

cURL

curl -X GET "https://api.shanyouxiang.com/open/order/info?clientKey={clientKey}&orderNo={orderNo}"

文档响应示例（非实时数据）

{
  "code": 0,
  "success": true,
  "message": "",
  "data": {
    "orderNo": "",
    "productId": 0,
    "productName": "",
    "quantity": 0,
    "unitPrice": 0,
    "totalAmount": 0,
    "status": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss"
  },
  "requestId": ""
}