产品介绍
地理围栏服务是一类HTTP接口,提供在服务端,增删改查地理围栏的功能,同时支持对于设备与围栏关系进行监控。
适用场景
地理围栏服务适用于需要针对特定区域,监控用户位置与区域关系的场景中。包括但不限于:签到打卡类场景,在用户打卡操作前,判断用户是否已经在对应的地理围栏区域内;
共享单车类场景,当用户骑车离开合法使用区域时,第一时间获知;或当用户关锁支付时,判断用户是否停在了合法区域内;
线下门店促销场景,当获取到用户定位在促销门店区域的附近时,向用户发送引导进入店铺的促销信息。
使用限制
目前开通web服务权限的开发者key都具有初级围栏使用权限(10个围栏),详细配额请在配额说明页查询。
使用说明
第一步,申请”Web服务API”密钥(Key),即可获得初级配额的围栏使用权限。
第二步,使用创建围栏接口新增围栏,目前支持圆形围栏和多边形围栏。使用其他增删改查接口管理围栏;
第三步,实际使用中,先获取用户设备位置,然后使用设备围栏监控接口,进行设备与围栏关系的判断。获取用户设备位置的方法,可参考定位相关信息。
需要注意的是:如无特殊声明,接口的输入参数和输出数据编码全部统一为UTF-8。
接口对应的请求方式:
方法名称请求方式
创建围栏POST
查询围栏GET
更新围栏PATCH
围栏启动&停止PATCH
删除围栏DELETE
围栏设备监控GET
创建围栏
创建地理围栏API服务POST请求地址:curl -i -X POST https://restapi.amap.com/v4/geofence/meta?key=用户key -d 'json'
请将json参数添加到body体中发送。query请求参数
key:用户唯一标识,必填。用户在高德地图官网申请Web服务API类型Keyjson请求参数
参数名含义规则说明是否必填缺省值
name围栏名称字母&数字&汉字必填无
center圆形围栏中心点longitude,latitude圆形围栏必填与points互斥无
radius圆形围栏半径单位:米。范围0~5000。圆形围栏必填与points互斥无
points多边形围栏坐标点lon1,lat1;lon2,lat2;lon3,lat3(3<=点个数<=5000)。多边形围栏外接圆半径最大为5000米。多边形围栏必填无
enable围栏监控状态布尔类型可选true
valid_time过期日期围栏有效截止日期,过期后不对此围栏进行维护(围栏数据过期删除);
不能设定创建围栏时间点之前的日期;
格式yyyy-MM-dd; 请设置2055年之前的日期可选创建时间后90天;
repeat一周内围栏监控日期的重复模式星期缩写列表,用","或“;”隔开。
样例:"Mon,Sat"
表示周一和周六有效。
星期简称如下(首字母大写):
Mon,Tues,Wed,Thur,Fri,Sat,Sun
repeat和fixed_date不能同时缺省或同时为空,二者所指出的监控日期为“或”关系可选,repeat和fixed_date不能同时缺省或同时为空,二者所指出的监控日期为“或”关系无
fixed_date指定日期列表格式"date1;date2;date3"; date格式"yyyy-MM-dd";
最大个数180,不能设定过去日期;
repeat和fixed_date不能同时缺省或同时为空,二者所指出的监控日期为“或”关系;可选,repeat和fixed_date不能同时缺省或同时为空,二者所指出的监控日期为“或”关系无
time一天内围栏监控时段开始时间和结束时间定义一时间段,可设置多个时间段,时间段按照时间顺序排列,各时间段不可重叠;
拼接字符串格式如:"startTime1,endTime1;startTime2,endTime2";
最大个数24;</