API Reference
DivePlan API
免费开放混气、减压和部分地图数据接口。涉及用户数据、合作配额、小程序迁移、云函数兼容和大模型分析样本的完整 API,仅向合作用户开放。
公开算法
混气、减压、MOD、END 等可直接调用
合作接口
用户数据和云函数迁移需开通
安全合规
私钥和第三方 key 不暴露给前端
个性优化
登录样本可支持用户级优化
合作接口
用户数据、云函数兼容、天气/航班/识别、大模型分析样本、管理员接口等不在公开文档展示。合作用户开通后可获得完整路径、参数、配额和签名/鉴权说明。
用户账号、资料、设置、API Key 管理
混气记录、规划记录、潜水日志同步
假期规划、一日多潜、减压计划归档与个性化优化
小程序云函数兼容接口与迁移支持
POI、天气、航班、物种识别等集成接口
合作方配额、访问密钥、调用审计和技术支持
公开请求示例
混气计算
POST /api/algorithms/mix/calculate
{
"tankSize": 11,
"startPressure": 50,
"targetPressure": 200,
"currentO2": 21,
"currentHe": 0,
"targetO2": 32,
"targetHe": 0
}减压模拟
POST /api/algorithms/deco/simulate
{
"gases": [
{ "name": "Air", "o2": 0.21, "he": 0 }
],
"divePlanPoints": [
{ "depth": 30, "duration": 20, "gasId": 1 }
]
}附近潜点
GET /api/dive-sites/near
GET https://api.diveplan.cn/api/dive-sites/near?lat=22.3&lng=114.1&radiusKm=50公开基础接口
| 方法 | 路径 | 权限 | 参数 | 说明 |
|---|---|---|---|---|
| GET | /healthz | 公开 | 无 | 服务健康检查 |
| GET | /api/algorithms/healthz | 公开 | 无 | 算法旁车健康检查 |
| GET | /api/maps/config | 公开 | 无 | Mapbox public token 配置 |
免费算法接口
混气、减压和常用潜水计算可直接调用。正式集成时建议保留安全免责提示。
| 方法 | 路径 | 权限 | 参数 | 说明 |
|---|---|---|---|---|
| POST | /api/algorithms/mix/calculate | 公开 | JSON | 混气计算 |
| POST | /api/algorithms/deco/simulate | 公开 | JSON | 减压模拟 |
| POST | /api/algorithms/dive/mod | 公开 | JSON | MOD |
| POST | /api/algorithms/dive/end | 公开 | JSON | END |
| POST | /api/algorithms/dive/eadd | 公开 | JSON | EAD/等效深度 |
| POST | /api/algorithms/dive/ndl | 公开 | JSON | NDL |
| POST | /api/algorithms/best-mix/calculate | 公开 | JSON | 最佳混合气 |
| POST | /api/algorithms/gas-budget/max-bottom-time | 公开 | JSON | 最大底时预算 |
| POST | /api/algorithms/gas-budget/default-reserve | 公开 | JSON | 默认保留气 |
| POST | /api/algorithms/gas-turn-point/compute | 公开 | JSON | 折返点计算 |
| POST | /api/algorithms/atmosphere/surface-pressure | 公开 | JSON | 海拔水面气压 |
公开地图数据
| 方法 | 路径 | 权限 | 参数 | 说明 |
|---|---|---|---|---|
| GET | /api/dive-sites/near | 公开 | lat, lng, radiusKm | OSM 附近潜点 |
| GET | /api/reefs/aca-tile-url | 公开 | 无 | ACA 瓦片配置、版本、图层 |
| GET | /api/reefs/tile-layers | 公开 | 无 | 珊瑚礁图层分组 |
| GET | /api/reefs/tile-cache/{version}/{provider}/{layer}/{z}/{x}/{y}.{format} | 公开 | path 参数 | 读取缓存瓦片 |
| GET | /api/reefs/tile-cache/{version}/{provider}/{layer}/{z}/{x}/{y}/features | 公开 | west, south, east, north, maxFeatures, gzip | GeoJSON 裁剪下发 |
| GET | /api/reefs/bbox | 公开 | west, south, east, north, maxFeatures | 珊瑚礁 bbox 查询 |
云端账户接口
Web、App、微信小程序共用;provider 为 google-photos 或 dropbox,第三方令牌只保存在服务端。
| 方法 | 路径 | 权限 | 参数 | 说明 |
|---|---|---|---|---|
| GET | /api/me/cloud-accounts | 登录 | 无 | 查询 Google Photos / Dropbox 连接状态 |
| GET | /api/me/cloud-accounts/{provider} | 登录 | provider | 查询单个云端账户状态 |
| POST | /api/me/cloud-accounts/{provider}/authorize | 登录 | {} | 获取一次性 OAuth 授权地址 |
| DELETE | /api/me/cloud-accounts/{provider} | 登录 | provider | 解除连接并删除服务端加密令牌 |
| POST | /api/me/cloud-accounts/google-photos/picker/sessions | 登录 | maxItemCount | 创建 Google Photos 选择会话 |
| GET | /api/me/cloud-accounts/google-photos/picker/sessions/{sessionId} | 登录 | sessionId | 查询照片选择状态 |
| GET | /api/me/cloud-accounts/google-photos/picker/sessions/{sessionId}/media-items | 登录 | pageSize, pageToken | 获取本次明确选择的照片/视频 |
| DELETE | /api/me/cloud-accounts/google-photos/picker/sessions/{sessionId} | 登录 | sessionId | 删除照片选择会话 |
| GET | /api/me/cloud-accounts/dropbox/files | 登录 | path | 只读列出 Dropbox 目录元数据 |
开放边界
免费接口仅用于计算和公开地图数据。涉及个人记录、合作方业务数据、第三方服务密钥、调用审计和用户级模型优化的接口,需要单独开通授权。