API接口说明书
一、统一说明
1. 通讯方式
数据接口采用http/https协议，通讯内容采用JSON数据格式。 
接口返回数据格式如下：
{"code":1001, "message":"信息内容", "data":object} 
﻿
ResultData字段说明
字段
类型
说明
code
Integer
代码(参考返回代码说明表)
message
String
返回操作结果描述
data
Json
Json数据，具体格式参考各个接口
﻿
文档中所有接口的返回数据说明表，如无特殊说明均为ResultData数据格式，返回的数据均存放于data字段中 
2. 接口调用注意事项
调用接口前需要去申请到appKey和appSecret以及有相应的接口授权才可以调用。接口中如无特殊说明，都是采用post方法进行调用，接口中参数为json格式。
3. 接口地址
正式环境接口地址
https://openapi.dc-dsc.alibaba.com
﻿﻿
二、素材准备
暂无
﻿
三、用户相关
3.1 根据userToken获取用户信息
3.1.1接口描述
接口编号
3.1
接口名称
根据userToken获取用户信息
功能描述
根据userToken获取用户信息，返回信息用户信息、角色信息、租户信息
接口地址
/openapi/user/getUserByToken
请求方式
POST
参数格式
﻿
返回数据格式
JSON
备注
﻿
3.1.2 请求参数说明
3.1.2.1 请求头Header参数
无
3.1.2.2 请求参数
字段
必选
类型
说明
requestId
是
string
请求ID，标识请求
timestamp
是
long
当前时间戳
appId
是
string
小程序ID，同申请的appKey
token
是
string
设置单点登录后返回的token
3.1.3返回数据说明
参数名
类型
说明
userName
string
用户名
userPhone
string
用户手机号
dctOrgName
string
组织名称
dctDeptName
string
部门名称
corpId
string
钉钉组织ID
ingdingUserId
string
钉钉用户userid
3.1.4返回格式示例
﻿﻿
3.2 新增用户
3.2.1接口描述
接口编号
3.2
接口名称
新增用户
功能描述
向数乡用户中心添加一个用户
接口地址
/openapi/user/addUser
请求方式
POST
参数格式
﻿
返回数据格式
JSON
备注
﻿
3.2.2 请求参数说明
3.2.2.1 请求头Header参数
无
3.2.2.2 请求参数
字段
必选
类型
说明
requestId
是
string
请求ID，标识请求
timestamp
是
long
当前时间戳
appId
是
string
小程序ID
userName
是
string
用户名称
userPhone
是
string
用户手机号
corpId
是
string
钉钉组织corpId
deptName
否
string
部门名称
3.2.3返回数据说明
参数名
类型
说明
corpId
string
组织ID
dingdingUserId
string
钉钉UserId
userCode
string
用户code
3.2.4返回格式示例
{
    "code": "0000",
"data":{
"corpId":"xxxx",
﻿﻿﻿﻿"dingdingUserId":"xxxx",
﻿﻿﻿﻿"userCode":"xxxx"
},
    "message": "成功",
    "success": true
}
3.3 查询用户信息
3.3.1接口描述
接口编号
3.3
接口名称
查询用户信息
功能描述
查询用户信息
接口地址
/openapi/user/getUser
请求方式
POST
参数格式
﻿
返回数据格式
JSON
备注
﻿
3.3.2 请求参数说明
3.3.2.1 请求头Header参数
无
3.3.2.2 请求参数
字段
必选
类型
说明
requestId
是
string
请求ID，标识请求
timestamp
是
long
当前时间戳
appId
是
string
小程序ID
userPhone
是
string
用户手机号
corpId
是
string
钉钉组织corpId
3.3.3返回数据说明
参数名
类型
说明
corpId
string
组织ID
dingdingUserId
string
钉钉UserId
dctDeptDTOList
list
部门列表
dctOrgRoleDTOList
list
角色列表
userId
long
用户ID
userName
string
用户名称
userPhone
string
用户手机号
dingdingActive
byte
是否已激活钉钉号，1：已激活/0：未激活
3.3.4返回格式示例
{
    "code": "0000",
    "data": {
    },
    "message": "成功",
    "success": true
}
﻿﻿
﻿
附录
返回代码
﻿
代码
说明
0000
接口执行成功，具体参考各个接口
4302
接口执行失败，具体参考各个接口，原因参考Message
5000
操作失败
接口调试示例
maven依赖导入
15

        <!-- 调用sdk -->
        <dependency>
            <groupId>com.aliyun.api.gateway</groupId>
            <artifactId>sdk-core-java</artifactId>
            <version>1.1.7</version>
        </dependency>
        <!-- fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.83</version>
        </dependency>

﻿
Java调用示例
99
package com.chatrobot.controller;

import java.io.IOException;
import java.util.Calendar;

import com.alibaba.cloudapi.sdk.client.ApacheHttpClient;
import com.alibaba.cloudapi.sdk.constant.SdkConstant;
import com.alibaba.cloudapi.sdk.enums.HttpMethod;
import com.alibaba.cloudapi.sdk.enums.Scheme;
import com.alibaba.cloudapi.sdk.model.ApiCallback;
import com.alibaba.cloudapi.sdk.model.ApiRequest;
import com.alibaba.cloudapi.sdk.model.ApiResponse;
import com.alibaba.cloudapi.sdk.model.HttpClientBuilderParams;
import com.alibaba.fastjson.JSONObject;

public class TestDemo extends ApacheHttpClient {
    /**
     * 您申请的appKey
     */
    public final static String APP_KEY = "xxx";
    /**
     * 您申请的appSecret
     */
    public final static String APP_SECRET = "xxx";
    /**
     * 调用域名
     */
    public final static String HOST = "openapi.dc-dsc.alibaba.com";
    /**
     * API实例
     */
    static TestDemo INSTANCE = new TestDemo();

    /**
     * 创建实例
     */
    public static TestDemo getInstance() {
        return INSTANCE;
    }

    static {
        HttpClientBuilderParams httpParam = new HttpClientBuilderParams();
        httpParam.setAppKey(APP_KEY);
        httpParam.setAppSecret(APP_SECRET);
        httpParam.setHost(HOST);
        httpParam.setScheme(Scheme.HTTP);
        getInstance().init(httpParam);
    }

    /**
     * 根据userToken获取用户信息
     */
    public void getUserByTokenHttpTest() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("requestId", "xxxxxxxxxxxxx");
        jsonObject.put("timestamp", Calendar.getInstance().getTime());
        jsonObject.put("appid", APP_KEY);
        jsonObject.put("token", "xxxx");
        String path = "/openapi/user/getUserByToken";
        ApiRequest request = new ApiRequest(HttpMethod.POST_BODY, path,
                                            jsonObject.toJSONString().getBytes(SdkConstant.CLOUDAPI_ENCODING));
        //Content-Type必须设置，否则接口无法获取到请求参数
        request.addHeader("Content-Type", "application/json");
        getInstance().sendAsyncRequest(request, new ApiCallback() {
            @Override
            public void onFailure(ApiRequest apiRequest, Exception e) {
                e.printStackTrace();
            }

            @Override
            public void onResponse(ApiRequest apiRequest, ApiResponse apiResponse) {
                try {
                    System.out.println(getResultString(apiResponse));
                } catch (Exception ex) {
                    ex.printStackTrace();
                }
            }
        });
    }

    private static String getResultString(ApiResponse response) throws IOException {
        StringBuilder result = new StringBuilder();
        result.append("Response fr om backend server").append(SdkConstant.CLOUDAPI_LF).append(SdkConstant.CLOUDAPI_LF);
        result.append("ResultCode:").append(SdkConstant.CLOUDAPI_LF).append(response.getCode()).append(
            SdkConstant.CLOUDAPI_LF).append(SdkConstant.CLOUDAPI_LF);
        if (response.getCode() != 200) {
            result.append("Error description:").append(response.getHeaders().get("X-Ca-Error-Message")).append(
                SdkConstant.CLOUDAPI_LF).append(SdkConstant.CLOUDAPI_LF);
        }
        result.append("ResultBody:").append(SdkConstant.CLOUDAPI_LF).append(
            new String(response.getBody(), SdkConstant.CLOUDAPI_ENCODING));
        return result.toString();
    }

    public static void main(String[] args) {
        new TestDemo().getUserByTokenHttpTest();
    }
}
﻿
﻿