文档中心

# 入门指南

最后更新时间: 2021年06月08日

本指南是向 Web 应用添加泛舟服务的快速入门指南。

# 第 1 步：获取泛舟Key

使用泛舟动力 Web服务 需要您在控制台获取Key (opens new window)。

# 第 2 步：Hello Ubiboat！

获取附近的信息

如下示例可以帮助您实现获取附近的信息功能，您可以参考：

简要描述：

  • 获取附近的信息

请求URL：

  • http://www.ubiboat.com/v1/web/locate

请求方式：

  • POST

请求类型：

  • application/json

注意事项：

请求参数：

参数名 必选 类型 说明
appUserId 是 string 用户的唯一ID
apList 否 string 扫描周边WIFI信息
beaconList 否 string 扫描周边的Beacon信息
time 否 string 扫描信号的时间

请求示例：

{
  "apList": [
    {
      "mac": "4a:0e:ec:ae:94:ed",
      "rssi": -65
    },
    {
      "mac": "48:0e:ec:ee:94:ed",
      "rssi": -65
    },
    {
      "mac": "20:6b:e7:36:64:af",
      "rssi": -65
    },
    {
      "mac": "50:db:3f:ec:0b:54",
      "rssi": -65
    },
    {
      "mac": "50:0f:f5:f3:62:e1",
      "rssi": -65
    }
  ],
  "appUserId": "121"
}

返回示例：

{
  "data": {
    "address": "北京市 海淀区 北四环西路辅路 靠近北京大学出版社(昊海楼北)",
    "appUserId": "121",
    "csys": "gcj02",
    "lat": 39.9848489,
    "lng": 116.3074759,
    "nearAnchor": [
      {
        "address": "北京市 海淀区 北四环西路辅路 靠近北京大学出版社(昊海楼北)",
        "anchorId": "12345",
        "csys": "gcj02",
        "distance": 0,
        "expirationTime": "2021-08-16 18:40:00",
        "groupId": "1",
        "lat": 39.9848497,
        "lng": 116.3074761,
        "time": "2021-08-16 15:56:08"
      }
    ],
    "nearPerson": [
      {
        "address": "北京市 海淀区 北四环西路辅路 靠近北京大学出版社(昊海楼北)",
        "appUserId": "111",
        "csys": "gcj02",
        "distance": 0,
        "lat": 39.9848489,
        "lng": 116.3074759,
        "time": "2021-08-16 16:44:18"
      }
    ],
    "time": "2021-08-16 16:44:37"
  },
  "msg": "success",
  "status": 1
}

返回参数说明

参数名 类型 说明
status int 1：正常 其它：异常
msg string 消息详情
data string 返回的数据
nearPerson array 附近的其他用户
nearAnchor array 附近的Anchor
address string 地址信息
appUserId string 其他用户的ID
time string 位置上报的时间
csys string 坐标系
lat double 纬度坐标
lng double 经度坐标
distance double 相对距离
time string 位置上报的时间
expirationTime string Anchor过期时间
groupId string Anchor分组

← 添加Anchor →