EPO平台开放接口
    EPO平台开放接口
    • 文档概述
    • 快速入门
    • 基础接口(必须)
    • 停车平台接口
    • 会议平台接口
    • 访客平台接口
    • 消费平台接口
    • 视频监控接口
    • 分析平台接口
    • 无感考勤
    • 附录

    快速入门

    一、入门前提#

    1.
    已获取EPO平台提供的appKey和appSecret(需向平台运营方申请);
    2.
    若需AES加密,AES加密key:同appkey,不足16位长度后面补0直到够16位长度。
    3.
    开发环境:JDK 8及以上版本,支持HTTP请求、JSON解析、MD5加密的依赖包(推荐OkHttp3、FastJson2);
    4.
    网络环境:第三方服务与EPO平台服务器网络互通,可访问平台接口根地址(http://ip地址:7777/)(根地址将连同appKey和appSecret一块提供)。

    二、核心依赖引入#

    在项目pom.xml(Maven)或build.gradle(Gradle)中引入必要依赖,用于HTTP请求、JSON处理及加密操作:

    Maven依赖#

    <!-- HTTP请求工具 -->
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.11.0</version>
    </dependency>
    <!-- JSON解析 -->
    <dependency>
        <groupId>com.alibaba.fastjson2</groupId>
        <artifactId>fastjson2</artifactId>
        <version>2.0.41</version>
    </dependency>
    <!-- 加密工具(JDK自带,无需额外引入) -->

    Gradle依赖#

    三、三步快速对接#

    第一步:核心配置与工具类准备#

    先定义全局配置(存储平台地址、鉴权信息)和通用工具类(处理加密、HTTP请求),复用性更强。

    1. 全局配置类#

    2. 通用工具类(加密+HTTP请求)#

    第二步:获取Access Token(身份鉴权)#

    所有业务接口调用前需先获取accessToken(身份凭证),token有效期为24小时,过期后需要重新获取。建议定时更新token。
    步骤如下:

    1. 接口信息#

    接口地址:${BASE_URL}open-api/video/getAccessToken
    请求方式:GET
    请求头:
    参数名类型说明
    appKeyString平台分配的appKey
    timestampLong当前时间Unix毫秒时间戳
    signString签名(规则:MD5-32(appKey+timestamp+appSecret),32小写

    2. Java实现代码#

    3. 响应示例#

    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "token": "98FDC1C3E7374F1AAA4FCAE3BD23ECAC49B8F9D00B3F41CA921BACBE5C8291B0"
      }
    }

    第三步:调用业务接口(以“添加车辆”为例)#

    获取accessToken后,即可调用具体业务接口,以下为“添加车辆”示例:

    1. 接口信息#

    接口地址:${BASE_URL}open-api/parking/add-car
    请求方式:POST
    请求头:
    参数名类型说明
    AccessTokenString第一步获取的Token
    请求体(JSON格式):
    参数名类型说明
    parkingIdString车场编号(必填)
    vehicleCodeString车牌号(必填)
    vehicleTypeString车辆类型(1:月租车,2:免费车,必填)
    userNameString车主姓名(必填)
    userPhoneNumberString车主手机号(必填)
    startTimeString授权开始时间(yyyy-MM-dd,必填)
    endTimeString授权结束时间(yyyy-MM-dd,必填)

    2. Java实现代码#

    3. 响应示例#

    {
      "code": 0,
      "msg": "操作成功"
    }

    四、常见问题排查#

    1.
    Token获取失败:
    检查appKey和appSecret是否正确;
    确认签名规则是否为md5(appKey+timestamp+appSecret)(大小写敏感,需小写);
    网络是否能访问平台接口地址。
    2.
    业务接口返回Token无效:
    Token是否过期(需24小时内重新获取);
    Token是否正确通过AccessToken请求头传入。
    3.
    接口调用返回参数错误:
    检查必填参数是否缺失(参考文档中各接口的“必填”标注);
    参数格式是否正确(如时间格式为yyyy-MM-dd);
    回调类接口需确认签名验证是否通过(appKey+timestamp+appSecret的MD5值)。
    4.
    网络超时:
    检查平台IP和端口是否正确,网络是否互通;
    防火墙是否开放出站/入站规则。

    五、开发建议#

    1.
    Token缓存:将accessToken缓存至本地或Redis,避免每次调用接口都重新获取,提高效率;
    2.
    异常处理:实际项目中需完善异常捕获(如网络异常、JSON解析异常),增加重试机制(如Token过期自动重试);
    3.
    参数校验:调用接口前校验必填参数,避免因参数缺失导致调用失败;
    4.
    加密规范:访客相关接口中敏感信息(姓名、手机号等)需按文档要求进行AES加密,密钥为appKey补0至16位;
    5.
    版本兼容:若后续平台接口更新,需及时同步文档中的参数变化,避免因接口迭代导致对接失败。
    通过以上步骤,即可快速完成EPO平台接口的Java对接。如需调用其他业务接口(如访客管理、视频监控),可参考官方文档,替换接口地址和请求参数即可。对接过程中若有疑问,可联系平台技术支持团队。
    修改于 2025-12-04 11:01:33
    上一页
    文档概述
    下一页
    基础接口(必须)
    Built with