概况
1-1 平台说明
1-2 接口规范
1-3 授权接口
1-4 公共接口
2-1 应用
2-2 项目
2-3 房间
2-4 客户
2-5 仪表
3-1 欠款查缴
3-2 费用账单
3-3 收款
3-4 公区仪表
4-1 工单
4-2 工单操作

关于开放平台

      开放平台面向用户(内部用户、外部伙伴和具有独立开发能力的个人开发者)提供物业社区服务的开放平台,支持用户作为应用开发者从开放平台上的这些服务获取需要的数据和将相关数据传入到开放平台上,帮助物业服务商整合业务系统。

      数据中台是指通过数据技术,对海量数据进行采集、计算、存储、加工,同时统一标准和口径 对用户开放。在当今互联网时代,用户才是商业战场的中心,为了快速响应用户的需求,借助平台化的力量可以事半功倍。不断快速响应、探索、挖掘、引领用户的需求,才是企业得以生存和持续发展的关键因素。

      选择合作伙伴应该遵循一个原则:愿意真的开放数据,愿意给实体产业赋能。


平台建设目标

  提供物业企业业务系统需要的数据获取服务

  提供物业社区服务需要的数据接入服务


平台核心能力

        开放平台是为物业社区应用开发者提供的平台,是基于金蝶云大量的用户和强大的连接能力,向物业企业与用户提供丰富的数据接口和服务的开放平台。

        合作伙伴通过开放平台,整合客户的业务系统,由于提升客户价值,获得收益。企业通过金蝶我家云开放平台,整合内部的信息系统,向企业用户提供更友好、更方便的企业服务。


接入方式

    (1)授权接入

            开发者拥有面向社区的App(微信号),通过授权,可以获得金蝶我家云的H5页面,嵌入到开发者的App中,向社区住户提供各类服务服务,如报修、缴费等。

    (2)微应用接入

            开发者没有App(微信号), 可以开发H5微应用,嵌入在App(微信号)中,向社区住户提供各类生活服务,如快递、家政等。

1.2.1    输入输出格式


采取JSON形式,对于输出内容的数据类型,包括:

布尔型(boolean):例如isNew:true|false,没有null值

数字型(int):例如number:3.1415,未设置时值为0

数字型(double):例如number:3.1415,未设置时值为0

字符串型(String):例如name:’张三’,没有null值,null需要转化为’’(空串)

对象类型(Object):null表示空对象,{…}表示非空对象【只有Object有null值】,对象的属性可以是boolean,int,double ,String,Object,Array, ArrayList.

数组与集合类型(Array, ArrayList,HashMap):则[]表示空数组或集合。

    没有null值,null需要转换为[],数组的元素可以是boolean,int,double ,String,Object,Array,ArrayList.HashMap。


1.2.2    返回结果统一规范

    通用输出值的格式具体如下

    {

        result: 1成功 2错误 3警告

        success:true|false,   //是否成功,boolean

        code:0,   //错误代码,用于错误的分类,int

        msg: //错误消息,成功时为null,失败时返回错误信息

        data:   //返回值,Object

    }


    对于返回的结果,有以下几种情况:

    •success=true:成功,此时errorCode=0,代表没有错误。其中data为返回的数据对象。data只可能是Object或Array类型。

    •success=false:失败,进一步查看errorCode确定错误的分类以确定下一步操作。对于每个接口来说,errorCode的情况可能都不一样,具体说明见各个接口。

   

    httpcode输出值说明

    0正常预期返回

    1001Miss key客户端没传递key

    1002Invalid key客户端传递的key 值非法

    1003Invalid access token客户端传递的token非法:伪造或过期

    1004Invalid signaturesignature签名验证错误

   


对上述401类返回,建议客户端直接跳转至登陆页让用户进行重新登陆;


1.2.3    授权域名

    请使用 https接入, http不保证可用


1.2.4    头信息

    所有接口需要传入 Head信息,格式如下


    参数说明类型是否必须

    appKeyApp KeyStringY 开发者账号创建授权接入

    clientTime访问时间毫秒数IntY在30分钟内有效

    version客户端版本StringY   固定值V1.0

    signature签名串StringY


     签名串生成规则见1.4.1签名算法