接口基础
PR系统支持API功能,API仅支持网络版。若您想实现房租管理智能化,可以使用本API实现。
启用接口
要启用API,需要先登录PR网络版,找到API设置菜单,将API功能设置为选用,即完成对API功能启用。
API KEY和API Secret请妥善保管,一旦泄露将导致您的文档系统可被第三方恶意修改。
若发现被泄露,请点击刷新API按钮。
接口全局说明
接口根据Restful规则进行编写,PR系统提供了四个请求类型:
请求方法 | 作用 |
---|---|
GET | 读取数据 |
POST | 新建数据 |
PUT | 更新数据 |
DELETE | 删除数据 |
因此,您在调用接口时,请发起对应的请求。
Headers鉴权
所有接口都通过headers存放api key 和 api secret 进行鉴权。请求格式如下:
参数 | 示例值 | 类型 | 默认值 | 是否必填 | 描述 |
---|---|---|---|---|---|
Authorization | Bearer base64(key:secret) | string | - | 必填 |
Authorization的组成需要将key和secret按照上表示例格式进行base64转换,在前缀带上Bearer+空格+base64转换后的字符串
例如上图base64转换后的字符串为:NU5XeEVKYmRaN3ZoYVpaQmxmVTVZdUQ1WHN0Umtodkk6ZkdzNkRRRG51VmRGV3NWY3RrYlVIQWZMcmZEQlh1aVE=
header填写的value则是:Bearer NU5XeEVKYmRaN3ZoYVpaQmxmVTVZdUQ1WHN0Umtodkk6ZkdzNkRRRG51VmRGV3NWY3RrYlVIQWZMcmZEQlh1aVE=
发送数据格式
向所有接口发送数据都是JSON字符串。
返回格式和状态
API所有返回信息均为JSON。
PR系统API请求成功下,一般只返回0和其他数字状态码,常见的302、401、404、500等等均会以HTTP状态码一并返回。
状态码 | 说明 |
---|---|
0 | 执行成功 |
其他数值 | 表示执行出错,msg字段会有对应错误提示 |
401 | 没有获得授权 |
404 | 接口不存在 |
500 | 请求的接口地址异常 |
501 | 请求的接口地址异常 |
502 | 服务器出错 |
免责声明
PESCMS RENT 房租管理系统仅为用户提供房租信息记录和自动计费功能。系统中的租金、用电费、水费等所有费用均由用户自行填写和管理,PESCMS 官方仅提供记录和计算的工具,不对用户输入的数据和定价承担任何责任。