产品介绍
开放帐号 API 是通过 HTTPS 协议访问远程服务的接口,提供地图小程序用户帐号相关的能力。
适用场景
使用限制
详细的服务调用量限制可点我查阅。
使用说明
接收请求返回的数据(JSON或XML格式),参考返回参数文档解析数据。
如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。
1.创建轻量地图
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
bizSign | 签名值 | 签名参数:cpBizId bizToken(详见签名规则) | string | 必填 | 无 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
cpBizId | 合作方业务id | 比如订单号 |
| 必填 | 无 |
请求body
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
mapTitle | 地图名称 |
| string | 必填 | 无 |
cpBizId | 合作方业务id | 比如订单号 |
| 必填 | 无 |
iconImageUrl | 项目头像 |
|
| 必填 | 无 |
cpCode | 渠道code | 由高德提供,代表渠道来源 |
| 必填 | 无 |
resources | 资源信息 | 见:OpenMapResourceDTO | List<OpenMapResourceDTO> | 必填 | 无 |
OpenMapResourceDTO
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
resourceType | 资源类型 | 4-点 6-面 | int | 必填 | 无 |
resourceTitle | 名称 |
| string | 必填 | 无 |
resourceDesc | 描述 |
| string | 必填 | 无 |
iconColorValue | 图标颜色 | 蓝色:#7E97FF,#4265FF 天蓝:#7AB1F5,#307EDF 浅蓝:#4CC7FF,#39A1F8 青色:#12E3AA,#18AD78 黄色:#FFBF00,#FD9A00 橙色:#FF983F,#F96328 红色:#EA7864,#D76049 浅红:#FF6968,#F74746 | string | 必填 | 无 |
subPoints | 点信息详情 | 见:OpenSubPointDTO | List<OpenSubPointDTO> | 必填 | 无 |
firstPointInfoStr | 首个点信息(poi标准信息) | 经纬度json字符串 例子:{"lon":116.42354,"lat":39.992811} | string | 必填 | 无 |
polygonInfoStr | 区域面的行点信息(wkt格式) | 例子: "POLYGON((120.158572 35.944551,120.158556 35.944549,120.158541 35.944546,120.158527 35.944541,120.158516 35.944533,120.158506 35.944524,120.158498 ))" | string | 必填 | 无 |
bizResourceTag | 合作方资源标签 | 合作方资源标签 例如: 1:目的地(取餐点/送餐点) 2:aoi(小区/商场等)入口 | int | 必填 | 无 |
OpenSubPointDTO
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
pointTitle | 名称 |
| string | 必填 | 无 |
pointDesc | 描述 |
| string | 必填 | 无 |
pointInfoStr | 点信息(poi标准信息) | 经纬度json字符串 例子:{"lon":116.42354,"lat":39.992811} | string | 必填 | 无 |
iconOutline | 点自定义扎标边框 | 见附件:外轮廓 面不支持自定义:写死surface | string | 必填 | 无 |
iconFiller | 点自定义扎标填充物 | 见附件 : 填充物 面不支持自定义:写死surface | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 见code说明 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 结果对象,包括下述字段: |
| workMapEncryptCode | 加密后的工作地图id | string |
|
2.删除轻量地图
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
bizSign | 签名值 | 签名参数:cpBizId bizToken(详见签名规则) | string | 必填 | 无 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
cpBizId | 合作方业务id | 比如订单号 |
| 必填 | 无 |
请求body
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
cpBizId | 合作方业务id | 比如订单号 |
| 必填 | 无 |
cpCode | 渠道code | 由高德提供,代表渠道来源 |
| 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 见code说明 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | bool | 删除结果 |
code说明
0、异常 |
1、成功 |
2、失败 |
3、参数错误 |
100010、biz sign error |
100011、token not register |
100012、查到用户信息失败 |
100014、计算加密字符错误 |
100015、计算解密字符错误 |
110009、user not exist |
附件