1. 组织与人员同步API接口规范

这里的接口用来处理企业内部组织架构与云之家组织架构的同步。

1.1. 授权说明

云之家组织与人员同步的接口，都需要通过云之家OAuth2.0授权协议进行授权,授权级别为resGroupSecret级，授权方式为在接口请求URL后面添加accessToken参数，例如新增组织接口：https://www.yunzhijia.com/gateway/openimport/open/dept/add?accessToken=xxxxxx。

1.2. 网络传输协议规范

1.2.1. 网络传输协议

HTTPS

1.2.2. 请求地址

https://www.yunzhijia.com

1.2.3. 请求方法

POST

1.2.4. 内容类型

Content-Type: application/x-www-form-urlencoded

1.3. 输入参数

^注意： 组织人员所有接口的输入为application/x-www-form-urlencoded表单格式，输入里面的data字段为json格式,请开发者知悉此区别。

输入参数说明如下：

1.4. 输出结果

默认的输出字符编码格式为UTF-8格式

输出内容的数据类型包括：

• 布尔型(Boolean),例如isNew:true|false
• 数字型(Number),例如number:3.1415
• 字符串型(String),例如name:'张三'
• 对象类型(Object),null表示空对象，{…}表示非空对象，对象的属性可以是Boolean, Number, String, Object, Array
• 数组类型(Array)：[]表示空数组。数组的元素可以是Boolean, Number, String, Object, Array

通用输出值的格式为JSON格式：

{
    "success": boolean,         //服务出现异常为false,其他为true
    "error":String,             //错误信息,success=false时携带此信息
    "errorCode":int,            //错误代码,用于错误的分类
    "data": Object/Array        //返回值,类似Map对象或者Array数组对象
}

对于返回的结果，有以下几种情况：

1. success=true: 成功，此时error=null、errorCode=100，代表没有错误。其中data为返回的数据对象，data只可能是Object或Array类型

2. success=false: 失败，进一步查看errorCode确定错误的分类以确定下一步操作，对于每个接口来说，errorCode的情况可能都不一样，具体说明见各个接口的说明，确认错误类型后可查看data数据了解详细错误原因

3. 批量处理只返回错误信息，无错误返回的表示导入成功

1.5. 错误码

当前已使用的错误代码定义见下表，表中列出了代码号、适用接口以及该错误代码的意义。

1.6. FAQ

暂无