1. 服务商相关接口

1.1. 服务商接口签名算法

API接口地址均采用统一的签名算法进行鉴权，具体的签名过程如下

/*PHP代码示例*/

$timestamp  = time();
$api_token  = 'mykey';
$salt  = 'party';
$channel_id = 3;

$signature= sha1($timestamp . $api_token .$salt . $channel_id);

api_token 注册服务商时生成，由第三方提供，参考 服务商注册

timestamp 单位为秒，从1970年1月1日至今的秒数

salt = party 代表拉取组织信息接口的签名

salt = auth 代表登录校验接口的签名

channel_id 渠道编号，参考 预分配信息表

接口需要自行根据此算法进行接口的鉴权。

1.2. 数据拉取协议

接口地址

/PARTY_API?data2pull=user, department

请求方式

POST

参数说明

返回值格式 成功

{
    "errcode": 0,
    "new_seq": "新的序列号",
    "data": "新增、修改的信息（data域）",
    "data_del": "需要删除的信息guid（data_del域）",
    "is_complete": 0
}

失败

{
    "errcode": "1001",
    "errmsg": "code对应的错误描述的备注信息"
}

返回参数说明

备注

• 1001：签名校验失败
• 1002：不合法的channel_code
• 1003：不合法的拉取对象
• 1004：时间戳失效
• 1005：access_token不合法

1.3. 组织架构获取接口

接口地址

/PARTY_API?data2pull=department

请求格式示范

返回格式示范

{
    "errcode": 0,
    "new_seq": "",
    "data": [
        {
            "dept_guid": "b8c961df-f188-82d6-96ee-e3973e909e26",
            "dept_name": "采购助手",
            "parent_guid": "",
            "sort": 0,
            "is_company": 0,
            "is_end_company": 0
        }
    ],
    "data_del": [],
    "is_complete": 1
}

返回参数说明

1.4. 用户获取接口

接口地址

/PARTY_API?data2pull=user

请求格式示范

参数说明

返回格式示范

{
    "errcode": 0,
    "new_seq": "",
    "data": [
        {
            "user_name": "龙卫民",
            "user_code": "16100000001",
            "tel": "16100000001",
            "user_guid": "106700",
            "email": "123@123.com",
            "is_disabled": 1,
            "depts": [
                "b8c961df-f188-82d6-96ee-e3973e909e26"
            ]
        },
        {
            "user_name": "zyj账号06",
            "user_code": "16100000005",
            "tel": "16100000005",
            "user_guid": "221976",
            "email": "123@123.com",
            "is_disabled": 1,
            "depts": [
                "b8c961df-f188-82d6-96ee-e3973e909e26"
            ]
        },
        {
            "user_name": "denghs",
            "user_code": "16100000007",
            "tel": "16100000007",
            "user_guid": "222030",
            "email": "123@123.com",
            "is_disabled": 1,
            "depts": [
                "b8c961df-f188-82d6-96ee-e3973e909e26"
            ]
        },
        {
            "user_name": "测试黄喻",
            "user_code": "16100000009",
            "tel": "16100000009",
            "user_guid": "222062",
            "email": "123@123.com",
            "is_disabled": 0,
            "depts": [
                "b8c961df-f188-82d6-96ee-e3973e909e26"
            ]
        },
        {
            "user_name": "同步测试名字",
            "user_code": "16100000004",
            "tel": "16100000004",
            "user_guid": "222063",
            "email": "123@123.com",
            "is_disabled": 1,
            "depts": [
                "b8c961df-f188-82d6-96ee-e3973e909e26"
            ]
        }
    ],
    "data_del": ["b8c961df-f188-82d6-96ee-e3973e909e29"],
    "is_complete": 1
}

返回参数说明

1.5. 推送用户和部门

此接口由云助手团队提供 接口地址

/api/tenant-open/third-party-push

请求格式示范

参数说明

返回格式示范

{
    "errcode": 0,
    "errmsg":"ok",
    "data": "已收到请求!",

}

1.6. notice_url推送回调接口返回数据结构

在用户设置了回调接口后，云助手服务器会在执行完拉取第三方通讯录后调用此接口，返回此接口执行结果

返回格式示范

{
  "channel_id": "7",
  "channel_code": "dev_fangl",
  "timestamp": "1525309650",
  "signature": "13bab3e0c8620adb7b3c1af9bd68b6970f10dda8",
  "result": "finish",
  "errcode":0
}  

{
  "channel_id": "7",
  "channel_code": "dev_fangl",
  "timestamp": "1525309650",
  "signature": "13bab3e0c8620adb7b3c1af9bd68b6970f10dda8",
  "result": "错误信息",
  "errcode":"错误码"
}

1.7. 创建第三方通讯录

此接口由云助手团队提供

此接口作用是可以在云助手租户外部联系人中创建一个通讯录，不会自动拉取组织架构和用户信息，如果需要拉取，则需要调用上面 推送用户和部门接口

接口地址

/api/tenant-open/create-party

请求格式示范

参数说明

返回格式示范

{
    "errcode": 0,
    "errmsg":"ok",
    "data": "已收到请求!",

}

2. 套件相关接口

2.1. 套件接口签名算法

API接口地址均采用统一的签名算法进行鉴权，具体的签名过程如下

/*PHP代码示例*/

$timestamp  = time();
$api_token  = 'mykey';
$salt  = 'suite-api-auth';

$signature= sha1($timestamp . $api_token .$salt);

api_token 注册套件时生成，由第三方提供,，参考 套件应用注册

timestamp 单位为秒，从1970年1月1日至今的秒数

salt = suite-api-auth 代表获取套件相关信息，如获取应用授权

接口需要自行根据此算法进行接口的鉴权。

2.2. 应用权限获取接口

接口地址（第三方提供）比如 http://bms.myfuwu.com.cn/m/DataApi/app/get-auth-apps

请求方式：

POST

请求格式示范

参数说明

返回格式示范

{
    "success": 1,// 1 成功 0 失败
    "errmsg": "",
    "errcode": 0,
    "data": [
        {
            "app_code": "MobileCheckRoom",
            "auth_status": 1
        },
        {
            "app_code": "MobileCheckQuality",
            "auth_status": 1
        }
    ]
}

返回参数说明

备注

• 1001：签名校验失败
• 1002：不合法的tenant_code
• 1003：不合法的suite_id
• 1004：时间戳失效