冰梭开放平台

将冰梭的传输能力开放给开发者。通过简单的 API 调用,即可在您的产品中集成安全、高效的文件传输功能。

CAPABILITIES

两种传输能力,按需选择

冰梭将传输能力抽象为两种开放形式,开发者可根据场景自主选择,流量均不经过应用服务器。

2G 内免费

P2P 直传

点对点直连传输,文件不经过任何服务器。适合实时传输、大文件快传场景。

  • 端到端直连,零中转
  • 基于 WebRTC,NAT 穿透
  • 2G 内免费,无需会员
  • 适合一次性传输
查看接入示例
🔒
会员权益

安全中转

文件经冰梭云端加密中转存储,支持多次下载、离线接收。适合跨网、异步传输场景。

  • 云端加密存储,安全可靠
  • 支持多次下载、离线接收
  • 消耗会员流量配额
  • 适合跨网、异步传输
查看接入示例
GET STARTED

四步快速接入

从创建应用到完成传输,只需四步。

1

创建应用

开放平台应用管理中创建应用,获取 AppKey 和 AppSecret。

2

选择能力

根据场景选择 P2P 直传或安全中转,引入对应 SDK。

3

签名调用

使用 HMAC-SHA256 签名,调用创建传输任务 API。

4

完成传输

P2P 直连传输文件,或通过中转链接下载。

P2P 直传示例

三行代码发起 P2P 传输

以 Node.js 为例,创建任务后通过 WebRTC 直连传输。

Node.js
// 1. 创建 P2P 传输任务
const iceshuttle = require('iceshuttle-sdk');
const client = new iceshuttle.Client({
  appKey: 'ak_xxxxxxxx',
  appSecret: 'your_app_secret'
});

// 2. 发起传输
const task = await client.createTransfer({
  type: 'p2p',
  fileName: 'report.pdf',
  fileSize: 1024 * 1024 * 50  // 50MB
});

// 3. 获取接收链接,分享给对方
console.log('接收链接: ' + task.signalingUrl);
console.log('信令Token: ' + task.signalingToken);
安全中转示例

创建中转任务,获取下载链接

以 Python 为例,创建中转任务后上传文件,获取可多次下载的链接。

Python
from iceshuttle import Client

client = Client(app_key='ak_xxxxxxxx', app_secret='your_app_secret')

# 1. 创建安全中转任务
task = client.create_transfer(
    type='relay',
    file_name='backup.zip',
    file_size=1024 * 1024 * 500,  # 500MB
    max_receive_count=5,
    expire_hours=72
)

# 2. 上传文件到中转地址
client.upload_file(task.upload_url, './backup.zip')

# 3. 分享下载链接
print(f'下载链接: {task.download_link}')
API REFERENCE

核心 API 一览

所有 API 均使用 HMAC-SHA256 签名认证,支持 RESTful 风格调用。

接口 方法 说明
/api/open/transfer/create POST 创建传输任务(P2P / 中转)
/api/open/transfer/{id} GET 查询传输任务状态
/api/open/transfer/{id}/ice GET 获取 P2P 信令和 ICE 配置
/api/open/transfer/{id}/upload POST 上传文件到中转存储(分块)
/api/open/transfer/{id}/download GET 获取中转下载链接
/api/open/transfer/{id}/complete POST 标记传输完成
SDK & TOOLS

多语言 SDK 支持

提供五种语言 SDK,覆盖主流开发场景。

JavaScript
npm install iceshuttle-sdk
Python
pip install iceshuttle
Java
Maven 依赖引入
Node.js
npm install iceshuttle-sdk
Go
go get iceshuttle-go
curl
无需SDK,命令行直调
DOCS & GUIDES

文档与接入引导

从快速入门到完整 API 参考,助您顺利完成接入。

📖

完整方案与接入文档

包含能力说明、接入流程、API 详细参数、签名算法、错误码等完整参考。

查看文档 →
📦

接入案例

提供 curl、JavaScript、Python、Node.js、Java、Go 等多语言完整接入示例,以及 CI/CD 场景案例。

查看案例 →
🔧

应用管理

创建应用、获取 AppKey/AppSecret、查看调用统计和调用明细。

前往管理 →
📋

实施方案与任务规划

开放平台的技术实施方案、开发任务规划和里程碑。

查看规划 →

开始构建您的传输能力

创建应用,获取 AppKey,三分钟完成接入。

前往创建应用