员工费用包预算查询

1.概述

客户平台通过【员工费用包预算查询】接口，按预算包维度查询员工当前预算额度。 对接中需要先联系客户经理/企业后台管理员取得费用包ID。

2.接口基本信息

名称	描述
请求方式	POST
调用地址	测试环境：https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/staff/budget/package/query 正式环境：https://bep-openapi.meituan.com/api/sqt/open/staff/budget/package/query
调用方	客户平台
响应方	美团企业版
响应超时时间	5秒
调用限频	每分钟访问不超过100次，每天累计访问不超过100000次

2.1.请求体

名称	类型	是否必填	示例	说明
accessKey	String	是		美团企业版分配给客户的接入秘钥
content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值，加密秘钥使用secretKey参数，详见签名实例

content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟，平台将直接拒绝本次请求
entId	Long	是	46574	企业ID
staffId	Long	否	12345	美团企业版系统的员工ID，staffId和staffIdentifier二者必传其一
staffIdentifier	String	否	001	企业内部的员工唯一标识，staffId和staffIdentifier必传其一，当二者均传参时，以staffId为准。
expenseNo	String	是	15061804991676621011	费用包ID。需要先在美团企业版系统内创建对应费用档案获取编码，查看路径：企业管理后台-费控中心-费用管理-详情，详见expenseNo对应元素

expenseNo字段获取方式

2.2.响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	56a0af18ae30a168d4006c7c	日志查询ID，用于排查问题
status	Integer	是	0	接口响应编码，编码枚举值和解决方案详见第四章错误码
msg	String	否		错误描述信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，解密秘钥使用secretKey参数

data解密后数据结构

名称	类型	是否必填	示例	说明
balance	String	是	32.00	员工预算余额，单位元，精确到小数点后两位，大于等于零

3.示例

3.1.请求示例

3.1.1.请求示例

{
    "accessKey":"B3GFJIEHNEM1RLV-TK",
    "content":"UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

3.1.2.请求参数content解析

{
  "ts": 123123,
  "entId": 100525,
  "expenseNo": "1590668810677940292",
  "staffIdentifier": "CMS0001",
  "staffId": 11000
}

3.2.响应示例

3.2.1.响应结果

{
    "traceId":"56a0af18ae30a168d4006c7c",
    "status": 0,
    "msg": null,
    "data":"UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

3.2.2.响应参数data解析

{
  "balance": "100.00"
}

4.错误码

4.1.公共错误码

错误码	错误描述	解决方案
10010002	企业已停止合作，请联系客户经理进行确认	将接口调用的entId参数给到客户经理，由客户经理确认企业状态是否在合作中
10010003	content不合法	详细阅读content参数加密说明（签名实例），确认content加密方式和content解密前传参是否正确
10010004	ts缺失或ts时间已过期	确认ts是否传值并为13位时间戳，如果正确传值，则确认请求发起时间与美团企业版接受请求的时间差是否超过10分钟
10010005	entId不能为空	entId参数不可为空，如果未拿到entId参数，可以咨询客户经理获取
20010001	accessKey不合法	检查accessKey是否为客户经理给到的值，如果accessKey值正确，确认调用环境是否和accessKey一致，如使用测试环境的accessKey调用线上的接口
20010002	请求path不合法	检查接口调用地址是否正确，如是否有非法字符
20010003	鉴权失败，无接口访问权限	将接口调用地址给到客户经理，由客户经理检查接口权限是否开通并保存成功
20010004	越权访问，无法访问该企业数据，请检查entId的正确性	检查accessKey和entId两个参数的对应关系是否正确
30010001	访问频率过高	请确认接口访问频率，每个接口默认调用限频为每分钟不超过100次，超出调用频率会调用此错误
30010002	访问次数超过配额	请确认接口的累计访问次数，每个接口的默认累计调用量为10w次，超出限额则会报错

4.2.业务错误码

错误码	错误描述	解决方案
10150001	请输入员工ID	请检查staffId和staffIdentifier字段是否为空，员工费用包预算查询接口中二者必传其一
10150003	请传入合法的费用包ID	请检查expenseNo字段传参是否为空，且与客户经理提供的编码一致。费用ID查看位置：企业管理后台-费控中心-费用管理-详情
40150003	员工预算账户不存在	请在企业后台检查员工余额是否存在，不存在时请为员工分配费用制度
40150001	未知错误，请联系美团侧研发	请提供响应结果中的traceId参数，联系客户经理进行排查

5.代码实例

依赖SDK包地址：SDK下载地址

import com.meituan.sqt.client.SqtClient;
import com.meituan.sqt.constant.CommonConstants;
import com.meituan.sqt.enums.ResponseStatusEnum;
import com.meituan.sqt.exception.MtSqtException;
import com.meituan.sqt.request.in.sqtbudget.ApiQueryStaffCurBudgetRequest;
import com.meituan.sqt.response.in.BaseApiResponse;
import com.meituan.sqt.response.in.sqtbudget.APIQueryStaffCurBudgetResultItem;

/**
 * @author zhaoruixing
 * @date 2023/4/7 10:20
 */
public class QueryStaffBudgetDemo {
    private static final String invokeUrl = "https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/staff/budget/package/query";

    private static SqtClient sqtClient = null;

    static {
        // 初始化SqtClient，只需要初始化一次即可
        // entId，accessKey，secretKey需要根据不同环境动态的设置获取
        sqtClient = new SqtClient.Builder()
                .setEntId(CommonConstants.entId)
                .setAccessKey(CommonConstants.accessKey)
                .setSecretKey(CommonConstants.secretKey)
                .build();
    }

    public static void main(String[] args) throws MtSqtException {
        ApiQueryStaffCurBudgetRequest queryStaffCurBudgetRequest = new ApiQueryStaffCurBudgetRequest();
        queryStaffCurBudgetRequest.setEntId(sqtClient.getEntId());
        queryStaffCurBudgetRequest.setTs(System.currentTimeMillis());
        queryStaffCurBudgetRequest.setStaffId(20205000L);
        queryStaffCurBudgetRequest.setExpenseNo("1552190409298427931");

        BaseApiResponse<APIQueryStaffCurBudgetResultItem> response = sqtClient.invokeApi(invokeUrl, queryStaffCurBudgetRequest, null, null);

        // 响应结果为空处理
        if (response == null) {
            // 处理响应结果为空情况
            // ...

        }
        // 获取结果
        if (ResponseStatusEnum.SUCCESS.getCode().intValue() == response.getStatus()) {
            // 成功
            APIQueryStaffCurBudgetResultItem resultItem = response.getRealData();
            // 处理业务逻辑
            // ...
        } else {
            // 处理失败场景
            handleRespFailResult(response);
        }
    }

    private static void handleRespFailResult(BaseApiResponse<APIQueryStaffCurBudgetResultItem> response) {
        // 访问频率过高
        if (ResponseStatusEnum.HIGH_FREQUENCY_ACCESS.getCode().intValue() == response.getStatus()) {
            // 解决方案参照：https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 访问次数超过配额
        if (ResponseStatusEnum.EXCEED_ACCESS_NUMBER.getCode().intValue() == response.getStatus()) {
            // 解决方案参照：https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 其它失败场景

    }
}

6.版本记录

版本号	版本日期	更新内容
v1.0	2023-02-02	新增员工费用包预算查询接口