产品介绍
该 API 是通过 HTTPS 协议访问远程服务的接口,提供生态企业账号相关能力。
使用限制
详细的服务调用量限制可点我查阅。
使用说明
接收请求返回的数据(JSON或XML格式),参考返回参数文档解析数据。
如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。
业务身份和业务签名
接口调用要求进行业务身份和签名校验,详情见:业务身份和业务签名 。
1. 企业员工账号登录
请求地址
业务签名参数
参数名 | 含义 | 说明 | 参数类型 | 是否必填 | 缺省值 |
corpId | 企业ID | 单独以QueryString形式传递,即作为url参数传递。 | string | 必填 | 无 |
bizToken | 接入方身份token | 由高德服务提供 | string | 必填 | 无 |
请求参数
参数名 | 含义 | 说明 | 参数类型 | 是否必填 | 缺省值 |
key | 请求服务权限标识 放到请求连接后面 | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
sig | 数字签名 放到请求连接后面 | 用户在高德地图官网申请Web服务API类型Key | string |
|
|
bizSign | 业务签名 放到请求连接后面 | 详见签名规则 | string | 非必填 | 无 |
appId | 接入方应用的唯一标识 | 类型:String 由高德内部生成 | string | 必填 | 无 |
corpId | 接入方的企业ID | 类型:String 不同appId下接入方自行定义 | string | 必填 | 无 |
thirdPartyId | 接入方人员唯一id | 类型:String | string | 必填 | 无 |
sourceChannel | 来源渠道 | 类型:String | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
参数名 | 含义 | 参数类型 | 说明 |
code | 返回结果状态值 | number | 0 未知错误; 1 请求成功; 2 请求失败; 3 参数错误; 更多错误码见文档底部 |
message | 返回状态说明 | string | 当 code 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务器时间戳 | number |
|
data | 扩展信息 | object | 备用,根据业务方定制开发。如无特殊要求,可以不解析 |
| openData | 类型:String .开放数据 | string | 携带此数据到高德端内 |
2.高德账号对应的三方账号换绑
请求地址
业务签名参数
参数名 | 含义 | 说明 | 参数类型 | 是否必填 | 缺省值 |
corpId | 企业ID | 单独以QueryString形式传递,即作为url参数传递。 | string | 必填 | 无 |
bizToken | 接入方身份token | 由高德服务提供 | string | 必填 | 无 |
请求参数
参数名 | 含义 | 说明 | 参数类型 | 是否必填 | 缺省值 |
key | 请求服务权限标识 放到请求连接后面 | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
sig | 数字签名 放到请求连接后面 | 用户在高德地图官网申请Web服务API类型Key | string |
|
|
bizSign | 业务签名 放到请求连接后面 | 详见签名规则 | string | 非必填 | 无 |
appId | 接入方应用的唯一标识 | 类型:String 由高德内部生成 | string | 必填 | 无 |
corpId | 接入方的企业ID | 类型:String 不同appId下接入方自行定义 | string | 必填 | 无 |
thirdPartyId | 接入方人员唯一id | 类型:String | string | 必填 | 无 |
sourceChannel | 来源渠道 | 类型:String | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
参数名 | 含义 | 参数类型 | 说明 |
code | 返回结果状态值 | number | 0 未知错误; 1 请求成功; 2 请求失败; 3 参数错误; 更多错误码见文档底部 |
message | 返回状态说明 | string | 当 code 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务器时间戳 | number |
|
data | 扩展信息 | object | 备用,根据业务方定制开发。如无特殊要求,可以不解析 |
| openData | 类型:String .开放数据 | string | 携带此数据到高德端内 |
3.三方账号对应的高德账号换绑
请求地址
业务签名参数
参数名 | 含义 | 说明 | 参数类型 | 是否必填 | 缺省值 |
corpId | 企业ID | 单独以QueryString形式传递,即作为url参数传递。 | string | 必填 | 无 |
bizToken | 接入方身份token | 由高德服务提供 | string | 必填 | 无 |
请求参数
参数名 | 含义 | 说明 | 参数类型 | 是否必填 | 缺省值 |
key | 请求服务权限标识 放到请求连接后面 | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
sig | 数字签名 放到请求连接后面 | 用户在高德地图官网申请Web服务API类型Key | string |
|
|
bizSign | 业务签名 放到请求连接后面 | 详见签名规则 | string | 非必填 | 无 |
appId | 接入方应用的唯一标识 | 类型:String 由高德内部生成 | string | 必填 | 无 |
corpId | 接入方的企业ID | 类型:String 不同appId下接入方自行定义 | string | 必填 | 无 |
thirdPartyId | 接入方人员唯一id | 类型:String | string | 必填 | 无 |
sourceChannel | 来源渠道 | 类型:String | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
参数名 | 含义 | 参数类型 | 说明 |
code | 返回结果状态值 | number | 0 未知错误; 1 请求成功; 2 请求失败; 3 参数错误; 更多错误码见文档底部 |
message | 返回状态说明 | string | 当 code 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务器时间戳 | number |
|
data | 扩展信息 | object | 备用,根据业务方定制开发。如无特殊要求,可以不解析 |
| openData | 类型:String .开放数据 | string | 携带此数据到高德端内 |
错误码说明
code值 | 说明 |
1 | 请求成功 |
0 | 未知错误 |
2 | 请求失败 |
3 | 参数错误 |
4 | 限流 |
100010 | 业务签名错误 |
100011 | token not register |
100012 | 查到用户信息失败 |
100014 | 计算加密字符错误 |
150001 | 三方手机号对应的高德账号已有绑定关系 |
150002 | 三方账号绑定的高德账号没有手机号 |