项目概览
我的 API Key
| API Key | 状态 | 备注 |
|---|
白名单
| 类型 | 值 |
|---|
设备登记
| 领朋设备ID/账号 | 备注 |
|---|
接口文档与在线调试
1. 基本信息
| 项 | 值 |
|---|---|
| 对接模式 | 本项目主动调用本平台接口获取数据 |
| 接口地址 | https://api.linkpoon.com |
| 请求方式 | HTTPS + GET |
| 鉴权参数 | apikey(API Key)、ts(UTC 时间)、sign(签名)—— 随 URL 传递,无需自定义请求头 |
| 设备标识 | linkpoon_num = 领朋设备ID/账号(设备在领朋平台上的号码,如 8505011843) |
2. 签名算法
sign = HMAC_SHA256(apikey + "|" + ts, api_secret)
^ 结果取 64 位小写 hex;api_secret 即你的 API Secret
# 举例
apikey = "5f3c9a1b7d2e4f6089abcdef01234567"
ts = "202609140850" # UTC 时间,格式 YYYYMMDDHHmm
待签串 = "5f3c9a1b7d2e4f6089abcdef01234567|202609140850"
sign = HMAC_SHA256_HEX(api_secret, 待签串)
# 完整请求(把 3 个鉴权参数拼在 URL 上即可)
GET https://api.linkpoon.com/api/gps/latest
?linkpoon_num=8505011843
&apikey=5f3c9a1b7d2e4f6089abcdef01234567
&ts=202609140850
&sign=c792a4b15aed58583bef33555ea28e9c7e83d2c46255ca9513bda7e489aea2fa
· ts 必须是 UTC 时间(北京时间 = UTC+8。例:本地 2026-09-14 16:50 → ts = 202609140850)
· ts 与服务器相差不超过 5 分钟,否则返回 401
· API Secret 只在生成 Key 时显示一次,请妥善保存(遗失只能重新生成)
· 调用来源受项目白名单限制,请提前把服务器出口 IP 告知平台
3. 接口一:查询设备最新位置
GET /api/gps/latest
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
linkpoon_num | string | 是 | 领朋设备ID/账号 |
https://api.linkpoon.com/api/gps/latest?linkpoon_num=8505011843&apikey={API_KEY}&ts={YYYYMMDDHHmm}&sign={SIGN}
URL 里同时带了鉴权参数(apikey / ts / sign),
签名规则见上方第 2 节。下方「在线调试」会自动生成带真实签名的完整 URL,可直接复制使用。
{
"code": 0,
"data": {
"linkpoonNum": "8505011843",
"deviceSn": "",
"longitude": "114.081833",
"latitude": "22.535995",
"speed": "0.13",
"direction": "352.07",
"time": "2026-09-14 01:29:27"
}
}
4. 接口二:查询历史轨迹
GET /api/gps/history
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
linkpoon_num | string | 是 | 领朋设备ID/账号 |
start | string | 是 | 开始时间 yyyy-MM-dd HH:mm:ss(按定位时间) |
end | string | 是 | 结束时间 yyyy-MM-dd HH:mm:ss |
limit | int | 否 | 返回条数,默认 100,最大 500。定位上报频繁时一天可能有数百条,需要更长轨迹请缩小时间范围分多次取 |
source | string | 否 | 数据来源:live=实时向领朋查询完整历史(默认);local=仅本地缓存(快,含订阅期间 + 历次实时查询沉淀的数据) |
timeout | number | 否 | 实时查询总时限(秒),默认 60,范围 5~300。数据多时可调大以拉全 |
https://api.linkpoon.com/api/gps/history?linkpoon_num=8505011843&start=2026-09-14%2000:00:00&end=2026-09-14%2023:59:59&limit=100&apikey={API_KEY}&ts={YYYYMMDDHHmm}&sign={SIGN}
{
"code": 0,
"source": "live",
"complete": true,
"count": 60,
"cached": 60,
"data": [
{ "linkpoonNum": "8505011843", "longitude": "104.668930", "latitude": "31.515760",
"speed": "0", "direction": "0", "time": "2026-08-25 10:40:30" },
{ "linkpoonNum": "8505011843", "longitude": "104.669120", "latitude": "31.515802",
"speed": "0.13", "direction": "352.07", "time": "2026-08-25 10:45:11" }
]
}
按定位时间升序返回;时间是字符串,比较时请按 yyyy-MM-dd HH:mm:ss 格式处理。
· complete=true 表示该时间段已全部拉完;false 表示查询超时提前返回,
数据可能不全(建议缩小时间范围后重试)
· source=live 耗时较长(领朋协议每页最多 24 条,需逐页翻取,通常 10~40 秒);
结果会自动沉淀到本地库,之后用 source=local 查询同一时间段即可秒回
· source=live 时若领朋链路不可用,会自动降级为本地数据,响应里的 source 会标明实际来源
5. 接口三:查询整组设备的当前位置
GET /api/gps/group
一次取回本项目群组内全部设备的当前位置,免去逐个调用 /latest,适合做设备总览或地图批量打点。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
include_idle | bool | 否 | 是否包含尚无定位数据的设备,默认 true;传 false 则只返回有定位的 |
https://api.linkpoon.com/api/gps/group?apikey={API_KEY}&ts={YYYYMMDDHHmm}&sign={SIGN}
{
"code": 0,
"count": 2, // 本次返回的设备数
"total": 2, // 项目内设备总数
"data": [
{ "linkpoonNum": "8505011843", "deviceSn": "",
"longitude": "104.668930", "latitude": "31.515760",
"speed": "10.0", "direction": "0.0",
"time": "2026-08-28 17:44:27", "hasData": true },
{ "linkpoonNum": "8505011873", "deviceSn": "",
"longitude": null, "latitude": null, "speed": null,
"direction": null, "time": null, "hasData": false }
]
}
设备清单 = 本项目登记的设备 ∪ 领朋组内成员 ∪ 已有定位数据的设备(三者合并去重)。
说明:领朋底层协议不支持按组订阅 GPS(协议限制),平台已在服务端按「组成员名单 → 逐个采集」统一入库,您一次调用即可取回整组。
提示:平台只对已登记的设备建立采集,新设备请告知平台添加,否则拿不到它的定位。
6. 错误码
| HTTP | 含义 | 处理建议 |
|---|---|---|
| 200 | 成功 | — |
| 401 | 缺少 API Key / 时间戳过期 / 签名错误 | 核对 ts 是否为 UTC 时间(北京时间需 −8 小时)、签名串拼接与密钥是否正确 |
| 403 | 调用来源不在该项目白名单内 | 把贵方服务器出口 IP 加入白名单(左侧「白名单」),或联系平台管理员 |
| 404 | 该设备暂无定位数据 | 确认领朋设备ID/账号正确、设备在线且已上报过定位 |
| 429 | 请求过于频繁 | 降低调用频率 |
7. 在线调试
填写参数后点「生成签名并调用」,下方会给出完整请求 URL(已带签名)、签名参数、curl 命令和真实响应,可直接复制给贵方工程师。
对接信息
推送接口
报文字段
| 字段 | 类型 | 说明 |
|---|
返回码处理策略
| 返回 | 处理 |
|---|
设备
当前已采集 0 台设备(设备清单由平台自动从领朋发现并登记)。
推送报文里的 deviceSn 即设备的领朋设备ID/账号;如需增删设备,请联系平台管理员。
注意事项
设备登记
本表 = 要采集哪些设备。设备一般由平台自动从领朋发现并登记,无需手工维护;
仅当设备不属于账号的任何组时,才需要在此补充。保存后立即生效(自动重新订阅)。
| 领朋设备ID/账号 | 备注 | 操作 |
|---|
白名单
白名单用来限制「从哪里可以调用本平台的接口」——填你们服务器的公网 IP 或域名。
本项目已启用白名单限制:只有名单内的来源能调用;未配置任何白名单 = 所有来源都被拒绝,请务必先把你们服务器的出口 IP 加进来。
| 类型 | 值 | 操作 |
|---|
调用来源
| 来源 IP | 最近调用 / 首次出现 | 记录 | 最近结果 | 白名单 | 操作 |
|---|
说明:同一来源每分钟只记一条,所以「记录」数小于实际请求数;被拒的调用也会记录(否则无法发现新 IP)。
报警记录
本平台收到的报警事件及转发结果,按时间倒序。
| 报警时间 | 来源设备 | 推送设备ID(deviceSn) | 类型 | 位置 | 转发 | 操作 |
|---|