开放生态数据同步最后更新时间: 2024年08月30日

产品介绍

该 API 是通过 HTTPS 协议访问远程服务的接口，提供生态相关数据(企业信息、员工信息、地图信息、资源信息等)的同步能力。

使用限制

详细的服务调用量限制可点我查阅。

使用说明

接收请求返回的数据（JSON或XML格式），参考返回参数文档解析数据。

如无特殊声明，接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。

业务身份和业务签名

接口调用要求进行业务身份和签名校验，详情见：业务身份和业务签名。

1. 同步企业信息

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/corp/sync?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识。放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名。	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	接入方的企业ID	类型：String 接入方的企业ID	string	必填	无
name	接入方企业名称	类型：String	string	必填	无
icon	接入方企业头像	类型：String	string	非必填	无
remark	接入方企业的备注	类型：String	string	非必填	无
owner	企业主在接入方的唯一标识	类型：String 不同appId下接入方自行定义	string	必填	无
sourceChannel	来源渠道	类型：String 由高德内部生成	string	必填	无
syncType	数据同步类型	类型：Integer 1 全量同步，2 增量同步	number	必填	无
definedResourceStates	该企业下被定义的资源状态集合。即在该企业下创建资源时，资源状态的值来自此处定义的集合。	举例： [ { "name": "王府井", "value": "1"// 注意：字符串类型 }, { "name": "西单", "value": "2"// 注意：字符串类型 } ]	array	非必填
	name	状态定义的名称。若资源状态集合有值，则name必填	string	非必填
	value	状态定义的值。若资源状态集合有值，则value必填	string	非必填

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

请求示例

{
    "appId":"amap_appId",
    "corpId":"tanji",
    "name":"探迹",
    "icon":"http://tanji.png",
    "remark":"这是备注",
    "owner":"zhagnsan",
    "sourceChannel":"source_channel",
    "sig":"dksfjldfaksdlfajsld",
    "syncType":1,
    "definedResourceStates": [
        {
            "name": "王府井",
            "value": "1"
        },
        {
            "name": "西单",
            "value": "2"
        }
    ]
}

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

2. 同步员工信息（批量）

新增/更新员工信息，批量上传

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/staff/sync?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识。放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	企业ID	类型：String	string	必填	无
sourceChannel	来源渠道	类型：String 由高德内部生成	string	必填	无
datas	需要新增的点数据	类型：List 员工具体信息，详细说明见下表格批量大小限制为200个	array	必填	无
syncType	数据同步类型	类型：Integer 1 全量同步，2 增量同步	number	必填	无

员工具体字段数据：

参数名	含义	说明	参数类型	是否必填	缺省值
thirdPartyUid	人员在接入方应用中的用户ID	类型：String	string	必填	无
staffId	人员ID，比如企业员工ID	类型：String	string	必填	无
nickname	人员昵称	类型：String	string	必填	无
icon	人员头像	类型：String	string	非必填	无
mobile	人员手机号	类型：String	string	非必填	无
role	角色	类型：Integer 1 管理员，2 普通成员	number	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

请求示例

{
    "appId":"appId",
    "sourceChannel":"channel_value",
    "corpId":"tanji",
    "syncType":"1",
    "datas":[
        {
            "thirdPartyUid":"600034550",
            "staffId":"0001",
            "nickname":"张三",
            "icon":"http://kdkdkdkdkd.png",
            "mobile":"18888888888",
          	"role":1
        },
        {
            "thirdPartyUid":"60003455",
            "staffId":"0002",
            "nickname":"李四",
            "icon":"http://kdkdkdkdkd.png",
            "mobile":"18888888887",
          	"role":2
        }
    ]
}

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

3. 同步地图信息（批量）

新增/更新地图信息，批量上传

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/map/sync?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	主体ID	类型：String 人员所属主体的ID，根据人员类型不同，可以是地图ID/企业ID	string	必填	无
sourceChannel	来源渠道	类型：String 由高德内部生成	string	必填	无
syncType	数据同步类型	类型：Integer 1 全量同步，2 增量同步	number	必填	无
datas	需要新增的点数据	类型：List 员工具体信息，详细说明见下表格批量大小限制为200个	array	必填	无

员工具体字段数据：

参数名	含义	说明	参数类型	是否必填	缺省值
thirdPartyMapId	接入方定义的地图唯一标识	类型：String	string	必填	无
name	地图名称	类型：String	string	必填	无
desc	地图描述	类型：String	string	必填	无
type	地图类型	类型：Integer 1: 团体类型；2: 个人类型	number	必填	无
coverImage	地图封面图链接	类型：String	string	非必填	无
owner	负责人在接入方的唯一标识	类型：String	string	必填	无
categorys	图层信息	JSON格式，示例： [ { "id":"xxx", "name":"图层1", "privateType":1 }, { "id":"xxx", "name":"图层2", "privateType":1 } ]	array	必填	无
	id	类型：String 图层id	string	必填	无
	name	类型：String 图层名称	string	必填	无
	privateType	类型：Integer 1 共有，2 私有	number	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

请求示例

{
    "appId":"4001",
    "corpId":"tanji",
    "sourceChannel":"tj_crm",
    "syncType":"1",
    "datas":[
        {
            "thirdPartyMapId":"tianji_0001",
            "name":"首开广场",
            "desc":"首开广场地图",
            "type":1,
            "coverImage":"http://coverImage.png",
            "owner":"00001",
            "categorys":[
                {
                    "id":"0001",
                    "name":"公海",
                    "privateType":1
                },
                {
                    "id":"0002",
                    "name":"私海",
                    "privateType":2
                }
            ]
        },
        {
            "thirdPartyMapId":"tianji_0002",
            "name":"望京soho",
            "desc":"望京soho地图",
            "type":1,
            "coverImage":"http://coverImage.png",
            "owner":"00002",
            "categorys":[
                {
                    "id":"0001",
                    "name":"公海",
                    "privateType":1
                },
                {
                    "id":"0002",
                    "name":"私海",
                    "privateType":2
                }
            ]
        }
    ]
}

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

4. 同步资源信息（批量）

新增/更新资源信息，批量上传

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/resource/sync?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	企业ID	类型：String	string	必填	无
sourceChannel	来源渠道	类型：String 由高德内部生成	string	必填	无
datas	需要新增/更新的资源数据	类型：List 资源具体信息，详细说明见下表格批量大小限制为200个	array	必填	无
syncType	数据同步类型	类型：Integer 1 全量同步，2 增量同步	number	必填	无
sig	数字签名	数字签名获取和使用方法	string	选择数字签名认证的用户必填	无

员工具体字段数据：

参数名	含义	说明	参数类型	是否必填	缺省值
thirdPartyMapId	接入方定义的地图唯一标识	类型：String	string	必填	无
thirdPartyResourceId	接入方应用下的资源ID	类型：String	string	必填	无
thirdPartyCategoryId	资源所属图层文件夹ID	类型：String	string	必填	无
name	资源名称	类型：String	string	必填	无
address	资源位置信息	类型：String	string	必填	无
state	资源状态	类型：String 客户端自定义，取值受限于同步企业信息时资源状态集合definedResourceStates内对象元素value字段的定义	string	非必填	无
responsibleUsers	负责人在接入方的唯一标识列表	类型：List<String>	array	非必填	无
type	资源类型	类型：Integer 1: 点；2: 线；3: 面	number	必填	无
owner	创建者或属主的用户标识	类型：String	string	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

请求示例

{
    "appId":"appId",
    "corpId":"corpId",
    "sourceChannel":"channel_value",
    "syncType":1,
    "datas":[
        {
            "thirdPartyMapId":"amap_thirdPartyMapId",
            "thirdPartyResourceId":"amap_thirdPartyResourceId",
            "thirdPartyCategoryId":"amap_thirdPartyCategoryId",
            "name":"首开广场",
            "address":"阜荣街10号",
            "state":1,
            "responsibleUsers":["1","2"],
            "type":1,
            "owner":"11"
        },
        {
            "thirdPartyMapId":"amap_thirdPartyMapId01",
            "thirdPartyResourceId":"amap_thirdPartyResourceId01",
            "thirdPartyCategoryId":"amap_thirdPartyCategoryId01",
            "name":"望京soho",
            "address":"望京街11号",
            "state":1,
            "responsibleUsers":["1","2"],
            "type":1,
            "owner":"22"
        }
    ]
}

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

5. 员工手机号更新

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/staff/mobile?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
thirdPartyUid	人员在接入方应用中的用户ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	企业ID	类型：String 人员所属主体的ID，根据人员类型不同，可以是地图ID/企业ID	string	必填	无
thirdPartyUid	人员在接入方应用中的用户ID	类型：String	string	必填	无
sourceChannel	来源渠道	类型：String	string	必填	无
mobile	人员手机号	类型：String	string	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

6. 企业数据删除

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/corp/delete?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	接入方的企业ID	类型：String 不同appId下接入方自行定义	string	必填	无
sourceChannel	来源渠道	类型：String	string	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

7. 人员数据删除

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/staff/delete?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
thirdPartyUid	人员在接入方应用中的用户ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	企业ID	类型：String	string	必填	无
thirdPartyUid	人员在接入方应用中的用户ID	类型：String	string	必填	无
sourceChannel	来源渠道	类型：String	string	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

8. 地图数据删除

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/map/delete?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
thirdPartyMapId	接入方定义的地图唯一标识	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	接入方的企业ID	类型：String 不同appId下接入方自行定义	string	必填	无
thirdPartyMapId	接入方定义的地图唯一标识	类型：String	string	必填	无
sourceChannel	来源渠道	类型：String	string	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息，类型可扩展	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

9. 资源数据删除

请求地址

URL	https://restwia.amap.com/api/v1/wia/ecology/resource/delete?key=******
请求方式	post/json

业务签名参数

参数名	含义	说明	参数类型	是否必填	缺省值
corpId	企业ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
thirdPartyMapId	接入方定义的地图唯一标识	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
thirdPartyResourceId	接入方应用下的资源ID	单独以QueryString形式传递，即作为url参数传递。	string	必填	无
bizToken	接入方身份token	由高德服务提供	string	必填	无

请求参数

参数名	含义	说明	参数类型	是否必填	缺省值
key	请求服务权限标识放到请求连接后面	用户在高德地图官网申请Web服务API类型KEY	string	必填	无
sig	数字签名放到请求连接后面	用户在高德地图官网申请Web服务API类型Key	string	非必填	无
appId	接入方应用的唯一标识	类型：String 由高德内部生成	string	必填	无
corpId	接入方的企业ID	类型：String 不同appId下接入方自行定义	string	必填	无
thirdPartyMapId	接入方定义的地图唯一标识	类型：String	string	必填	无
thirdPartyResourceId	接入方应用下的资源ID	类型：String	string	必填	无
sourceChannel	来源渠道	类型：String	string	必填	无

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明：

参数名	含义	参数类型	说明
code	返回结果状态值	number	0 未知错误； 1 请求成功； 2 请求失败； 3 参数错误；更多错误码见文档底部
message	返回状态说明	string	当 code 为 0 时，message 会返回具体错误原因，否则返回“Successful”。详情可以参阅info状态表
timestamp	服务器时间戳	number
data	扩展信息	object	备用，根据业务方定制开发。如无特殊要求，可以不解析

返回结果示例

{
    "code":1,
    "message":"Successful",
    "timestamp":1671509034000,
    "data":null
}

错误码说明

code值		说明
1		请求成功
0		未知错误
2		请求失败
3		参数错误
4		限流
100010		业务签名错误
130001		批量操作数据量超出限制
130002		图层数据量超出限制
130003		定义的资源状态据量超出限制
130004		存在重复的资源状态定义
130005		存在重复的资源数据
130006		存在重复的图层数据

开放生态数据同步 最后更新时间: 2024年08月30日

产品介绍

使用限制

使用说明

业务身份和业务签名

1. 同步企业信息

请求地址

业务签名参数

请求参数

返回参数

请求示例

返回结果示例

2. 同步员工信息（批量）

请求地址

业务签名参数

请求参数

返回参数

请求示例

返回结果示例

3. 同步地图信息（批量）

请求地址

业务签名参数

请求参数

返回参数

请求示例

返回结果示例

4. 同步资源信息（批量）

请求地址

业务签名参数

请求参数

返回参数

请求示例

返回结果示例

5. 员工手机号更新

请求地址

业务签名参数

请求参数

返回参数

返回结果示例

6. 企业数据删除

请求地址

业务签名参数

请求参数

返回参数

返回结果示例

7. 人员数据删除

请求地址

业务签名参数

请求参数

返回参数

返回结果示例

8. 地图数据删除

请求地址

业务签名参数

请求参数

返回参数

返回结果示例

9. 资源数据删除

请求地址

业务签名参数

请求参数

返回参数

返回结果示例

错误码说明

开放生态数据同步最后更新时间: 2024年08月30日