开发 地图小程序OPENAPI 开发指南 企业组织 企业组织生产

企业组织 最后更新时间: 2024年08月30日

产品介绍

该 API 是通过 HTTPS 协议访问远程服务的接口,提供修改组织信息、添加/移除组织成员、修改组织成员信息的能力。

使用限制

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

业务身份和业务签名

bizToken和bizSign的详情见:点我查阅 。

使用说明

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

1.获取组织信息

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

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/info

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

                    规则说明

  参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户ID

用户在高德的身份ID

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:openId(详见签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

  String url = "https://restwia.amap.com/api/v1/wia/org/info";
  Map<String, Object> params = new HashMap<>();
  String openId = "当前操作用户的openId";
  params.put("key","在高德开放平台申请的key");
  params.put("openId",openId);
  params.put("bizToken","在高德开放平台申请的bizToken");
  String[] signArgs = new String[]{openId};
  params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));

  String response = MyHttpUtils.postFormUrlencoded(url, params);
  System.out.println(response);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

data

{
		"orgId": "_Nxlz8bfX64XGKLRNNYXJq0sG7xmwbnCwIE",/*企业
    id*/
		"gmtCreate": 1686542542000,/*创建时间*/
		"gmtModified": 1686647246000,/*修改时间*/
		"orgName": "xxx环卫集团",/*企业名称*/
		"orgIconImage": "https://track-record-file-base.amap.com/org/default/blue.png?x-oss-process=image/watermark,size_68,text_5pyq,color_FFFFFF,t_100,g_center",/*企业头像*/
		"creatorOpenId": "C2veyepHdqjCXANpj7jQ4OBN585KzlV3FcadJTHzKCuH4pOyjTN1n9sd",/*创建者openId*/
		"superManagerOpenId": "C2veyepHdqjCXANpj7jQ4OBN585KzlV3FcadJTHzKCuH4pOyjTN1n9sd",/*所有者openId*/
		"creatorAndSuperManagerInfo": {/*创建者、所有者用户信息*/
			"C2veyepHdqjCXANpj7jQ4OBN585KzlV3FcadJTHzKCuH4pOyjTN1n9sd": {/*此用户openId*/
				"openId": "C2veyepHdqjCXANpj7jQ4OBN585KzlV3FcadJTHzKCuH4pOyjTN1n9sd",/*此用户openId*/
				"nickName": "amap_WvAVtQ3DrT",/*此用户昵称*/
				"iconImage": "http://img-cdn-test.amap.com/g/avatar/13.png?ver=1686661244&imgoss=1"/*此用户头像 url*/
			}
		}
	}

2. 修改组织信息

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/update

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

orgName

组织名称

地图名称长度最大不能超过32位,不能存在违反相关法律法规的敏感词汇

orgIcon

组织头像

头像URL,需保证公网可访问下载

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

bizSign

业务签名

签名参数:openId(详见签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/update";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));


    params.put("orgName", "更新后的组织名称");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110002、组织不存在

110003、企业名称违规

110004、用户无权限

110007、企业名称长度超限

3. 添加组织成员

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/member/add

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

nickname

用户昵称

昵称长度最大不能超过32位,不能存在违反相关法律法规的敏感词汇

icon

用户头像

头像URL,需保证公网可访问下载

bizSign

业务签名

签名参数:openId(详见签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String url = "https://restwia.amap.com/api/v1/wia/org/member/add";
        Map<String, Object> params = new HashMap<>();

        params.put("key", "在高德开放平台申请的key");
        //被移除人在组织中的openId,可通过获取开放账号接口获取
        String openId = "被移除人在组织中的openId";
        params.put("openId", openId);
        //组织的bizToken
        params.put("bizToken", "在高德开放平台申请的bizToken");
        String[] signArgs = new String[]{openId};
        params.put("bizSign", SignatureHelper.calcSign(env.getBizSecret(), signArgs));

        String response = MyHttpUtils.postFormUrlencoded(url, params);
        System.out.println(response);

    }

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110002、组织不存在

110005、组织成员数量已达上限

110006、成员昵称违规

4. 移除组织成员

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/member/delete

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户id

用户在高德的身份id

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

bizSign

业务签名

签名参数:openId(详见签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String url = "https://restwia.amap.com/api/v1/wia/org/member/delete";
        Map<String, Object> params = new HashMap<>();

        params.put("key", "在高德开放平台申请的key");
        //被移除人在组织中的openId,可通过获取开放账号接口获取
        String openId = "被移除人在组织中的openId";
        params.put("openId", openId);
        //组织的bizToken
        params.put("bizToken", "在高德开放平台申请的bizToken");
        String[] signArgs = new String[]{openId};
        params.put("bizSign", SignatureHelper.calcSign(env.getBizSecret(), signArgs));

        String response = MyHttpUtils.postFormUrlencoded(url, params);
        System.out.println(response);
    }

返回参数

返回字段

含义

规则说明

data

数据体

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110002、组织不存在

5. 修改组织成员信息

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/member/update

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

nickname

用户昵称

地图名称长度最大不能超过32位,不能存在违反相关法律法规的敏感词汇

icon

用户头像

头像URL,需保证公网可访问下载

bizSign

业务签名

签名参数:openId(详见签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/member/update";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));


    params.put("nickname", "修改后的用户昵称");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110001、成员不在组织内

110002、组织不存在

110006、成员昵称违规

6. 管理员修改任意组织成员信息

请求地址

URL

https://restapi.amap.com/api/v1/wia/org/member/modify

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:

  1. nickname 和 icon 不能同时为null。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

管理员高德开放用户ID

管理员用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

empOpenId

被修改人员的高德的身份ID

被修改用户在高德的身份ID

nickname

用户昵称

地图名称长度最大不能超过32位,不能存在违反相关法律法规的敏感词汇

icon

用户头像

头像URL,需保证公网可访问下载

bizSign

业务签名

签名参数:openId(详见签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restapi.amap.com/api/v1/wia/org/member/modify";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("empOpenId", "被修改人员的高德的身份ID");
    params.put("nickname", "修改后的用户昵称");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110001、成员不在组织内

110002、组织不存在

110006、成员昵称违规

7. 批量查询企业成员

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/member/list

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

openId

高德开放用户ID

当前操作人在高德的身份ID

openIds

要查询的多个用户的开放用户ID

半角逗号分隔,最多100个

bizSign

业务签名

签名参数:openId(详见签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/member/list";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    // 半角逗号分隔,最多100个
    params.put("openIds", "要查询的多个用户的开放用户ID");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);

}

返回参数

返回字段

含义

规则说明

data

数组,格式如下:

[

  {

    "openId": "高德开放用户ID",

    "nickname": "昵称",

    "icon": "头像",

    "createTime": 1692013645523 // 时间戳

  }

]

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式

附表

0、异常

1、成功

2、失败

3、参数错误

110001、当前操作人不在组织内

返回顶部 示例中心 常见问题 智能客服 公众号
二维码