API 参考

iClick 提供了基于 WebSocket 的接口，默认监听本地 23188 端口。

连接说明

连接地址： ws://127.0.0.1:23188

通信协议

请求格式

客户端发送 JSON 格式的请求：

{
  "type": "api_method_name",
  "evtid": "unique_event_id",
  "timeout": 18,
  "param1": "value1",
}

字段说明：

• type (string): API 方法名称
• evtid (string): 唯一的事件 ID，用于匹配请求和响应
• timeout (number): 超时时间（秒），非必填，部分接口支持
• 其他参数根据具体 API 方法而定

响应格式

服务端返回两种格式：

1. JSON 格式响应（普通数据）：

{
  "evtid": "unique_event_id",
  "type": "success",
  "data": /*返回结果*/
}

2. 二进制格式响应（包含二进制数据）：

二进制数据格式：[6字节元数据长度][元数据JSON][二进制数据]

• 前 6 字节：UTF-8 编码的元数据长度字符串
• 元数据：JSON 格式的响应信息
• 二进制数据：实际的二进制内容

错误响应

{
  "evtid": "unique_event_id",
  "type": "error",
  "error": "错误信息"
}

服务端事件推送

服务端主动推送的事件：

{
  "type": "event",
  "event": "event_name",
  "data": { "payload": "..." }
}

📢 事件通知

查看 事件通知 了解所有可用的事件类型和详细说明

客户端实现

我们提供了多种编程语言的 WebSocket 客户端实现示例，方便你快速接入 iClick API：

📚 多语言支持

查看 多语言客户端实现 获取完整的客户端代码示例