接口清单

接口说明

我们只梳理了比较重要的接口协议,其他如果需要请自行查看代码梳理协议

接口清单

接口名称调用地址调用方式实现方式
添加员工https://api.OAPro.com/v1/Staff/POSTFlask DRF
修改员工https://api.OAPro.com/v1/Staff/id/PUTFlask DRF
员工详情https://api.OAPro.com/v1/Staff/id/GETFlask DRF
员工列表https://api.OAPro.com/v1/Staff/GETFlask DRF
员工离职https://api.OAPro.com/v1/Staff/id/DELETEFlask DRF
添加职位https://api.OAPro.com/v1/Position/POSTFlask DRF
职位修改https://api.OAPro.com/v1/Position/p_id/PUTFlask DRF
职位删除https://api.OAPro.com//v1/Position/p_id/DELETEFlask DRF
获取职位https://api.OAPro.com/v1/Position/GETFlask DRF
职位信息展示https://api.OAPro.com/v1/Position/p_id/GETFlask DRF
部门添加https://api.OAPro.com/v1/Department/POSTFlask DRF
部门信息修改https://api.OAPro.com/v1/Department/d_id/PUTFlask DRF
部门关联职位https://api.OAPro.com/v1/Department/d_id/p_id/PUTFlask DRF
部门删除https://api.OAPro.com/v1/Department/d_id/DELETEFlask DRF
部门信息展示https://api.OAPro.com/v1/Department/d_id/GETFlask DRF
考勤申请https://api.OAPro.com/v1/Attendance/PUTFlask DRF
考勤审批https://api.OAPro.com/v1/Attendance/a_id/PUTFlask DRF
考勤驳回https://api.OAPro.com/v1/Attendance/a_id/PUTFlask DRF
考勤数据统计https://api.OAPro.com/v1/Attendance/date/GETFlask DRF
绩效申报https://api.OAPro.com/v1/KPI/u_id/date/POSTFlask DRF
绩效审核https://api.OAPro.com/v1/KPI/u_id/date/PUTFlask DRF
绩效展示https://api.OAPro.com/v1/KPI/u_id/date/GETFlask DRF
绩效管理https://api.OAPro.com/v1/KPI/u_id/date/PUTFlask DRF
权限添加https://api.OAPro.com/v1/Permission/POSTFlask DRF
权限分配https://api.OAPro.com/v1/Permission/PUTFlask DRF
权限查看https://api.OAPro.com/v1/Permission/GETFlask DRF
权限删除https://api.OAPro.com/v1/Permission/DELETEFlask DRF
权限校验https://api.OAPro.com/v1/Permission/GETFlask DRF
新闻发布https://api.OAPro.com/v1/New/POSTFlask DRF
新闻查看https://api.OAPro.com/v1/New/n_id/GETFlask DRF
新闻修改https://api.OAPro.com/v1/New/n_id/PUTFlask DRF
新闻删除https://api.OAPro.com/v1/New/n_id/DELETEFlask DRF
周报编写https://api.OAPro.com/v1/Weekly/POSTFlask DRF
周报审核https://api.OAPro.com/v1/Weekly/w_id/PUTFlask DRF
周报查看https://api.OAPro.com/v1/Weekly/w_id/GETFlask DRF
周报修改https://api.OAPro.com/v1/Weekly/w_id/PUTFlask DRF
周考勤分析https://api.OAPro.com/v1/Attendance/week/GETFlask DRF
月考勤分析https://api.OAPro.com/v1/Attendance/month/GETFlask DRF
季度考勤分析https://api.OAPro.com/v1/Attendance/quarter/GETFlask DRF
年考勤分析https://api.OAPro.com/v1/Attendance/year/GETFlask DRF
个人KPI分析https://api.OAPro.com/v1/KPI/u_id/GETFlask DRF
部门KPI分析https://api.OAPro.com/v1/KPI/d_id/GETFlask DRF
公司KPI分析https://api.OAPro.com/v1/KPI/company/GETFlask DRF

调用流程

接口接入

1.登录OA开发者平台

登录OA开发者平台(https://develp.OAPro.com),注册账号

2.创建应用,获取app_id

images-11.png

接口调用流程

1.接口网关

开发网关地址 (https://api.OAPro.com/v1/UserInfo/

测试网关地址(https://api.OAPro.com/t/

2.常用参数
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
3. 举例

URL POST https://api.OAPro.com/Auth/

pidfile=/opt/script/uwsgi.pid

http=192.168.2.69:8000 #指定IP端口

请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"username": "admin",
	"password": "123456"
}
响应报文
{
	"code": 200,
	"data": {
		"token": "kaflj32oicOAc4lsms35alkf"
	}
}
4. 请求案例
import requests

url = "https://api.OAPro.com/v1/UserInfo/User/"

headers = {
	Content-Type: applicatiton/json
}

data = {
	"APP_ID": "8000418002",
	"REQ_TIME" "20201113225612",
	"SIGN":"aabdncdhdbd878sbdudn898",
	"username": "admin"
	"password": "123456"
}

response = requests.post(url = url,headers = headers,data = data)

result = reponse.json

 

员工管理

说明

用户类结构一共包括:添加员工、修改员工、员工详情、员工列表、员工离职 五个功能,负责整个项目的职员管理

添加员工

接口功能

添加员工

URL

https://api.OAPro.com/v1/Staff/

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
username1string32用户名用户名不可以以数字开头
password1string32密码密码必须有大小写字母或者字母数字
photo1path 头像头像路径
nickename1string32实名名字
phone1string32电话大陆+86 11位电话号
p_id1int 职位id外键
d_id1int 部门id外键
返回数据

数据格式

{
	"code": "200",
	"data": {
		"username": “zhangsan”,
		"password": “123456”,
		"photo": “/image/photo.jgp/”,
		"nickename": “张三”,
		"phone": “13331153369”,
		"p_id": 1,
		"d_id": 1
	}
}
状态码描述
200添加员工
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"username": “zhangsan”,
	"password": “123456”,
	"photo": “/image/photo.jgp/”,
	"nickename": “张三”,
	"phone": “13331153369”,
	"p_id": 1,
	"d_id": 1
}
响应报文
{
	"code": 200,
	"data": {
		"username": “zhangsan”,
		"password": “123456”,
		"photo": “/image/photo.jgp/”,
		"nickename": “张三”,
		"phone": “13331153369”,
		"p_id": 1,
		"d_id": 1
	}
}

 

修改员工

接口功能

修改员工

URL

https://api.OAPro.com/v1/Staff/id/

支持格式

JSON

HTTP请求方式

PUT

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
username1string32用户名用户名不可以以数字开头
password1string32密码密码必须有大小写字母或者字母数字
photo1path 头像头像路径
nickename1string32实名名字
phone1string32电话大陆+86 11位电话号
p_id1int 职位id外键
返回数据

数据格式

{
	"code": "200",
	"data": {
		"username": “zhangsan”,
		"password": “123456”,
		"photo": “/image/photo.jgp/”,
		"nickename": “张三”,
		"phone": “13331153369”,
		"p_id": 1,
		"d_id": 1
	}
}
状态码描述
200添加员工
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"username": “zhangsan”,
	"password": “123456”,
	"photo": “/image/photo.jgp/”,
	"nickename": “张三”,
	"phone": “13331153369”,
	"p_id": 1,
	"d_id": 1
}
响应报文
{
	"code": 200,
	"data": {
		"username": “zhangsan”,
		"password": “123456”,
		"photo": “/image/photo.jgp/”,
		"nickename": “张三”,
		"phone": “13331153369”,
		"p_id": 1,
		"d_id": 1
	}
}

员工详情

接口功能

员工详情

URL

https://api.OAPro.com/v1/Staff/id/

支持格式

JSON

HTTP请求方式

GET

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
username1string32用户名用户名不可以以数字开头
password1string32密码密码必须有大小写字母或者字母数字
photo1path 头像头像路径
nickename1string32实名名字
phone1string32电话大陆+86 11位电话号
p_id1int 职位id外键
返回数据

数据格式

{
	"code": "200",
	"data": {
	"username": “zhangsan”,
	"password": “123456”,
	"photo": “/image/photo.jgp/”,
	"nickename": “张三”,
	"phone": “13331153369”,
	"p_id": 1,
	"d_id": 1
}
}
状态码描述
200修改成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
token:aabdncdhdbd878sbdudn898
请求报文:
{
	"token": "5qe6sd3dasdasdasd4a",
	"password": "123456",
	"u_id": 1
}
响应报文
{
	"code": 200,
	"data": {
		"username": “zhangsan”,
		"password": “123456”,
		"photo": “/image/photo.jgp/”,
		"nickename": “张三”,
		"phone": “13331153369”,
		"p_id": 1,
		"d_id": 1
	}
}

员工列表

接口功能

员工列表

URL

https://api.OAPro.com/v1/Staff/

支持格式

JSON

HTTP请求方式

GET

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string-校验数据平台下发
返回数据

数据格式

{
	"code": "200",
	"data": [
		{
			"username": “zhangsan”,
			"password": “123456”,
			"photo": “/image/photo.jgp/”,
			"nickename": “张三”,
			"phone": “13331153369”,
			"p_id": 1,
			"d_id": 1
		},
		{
			"username": “zhangsan”,
			"password": “123456”,
			"photo": “/image/photo.jgp/”,
			"nickename": “张三”,
			"phone": “13331153369”,
			"p_id": 1,
			"d_id": 1
		},
		{
			"username": “zhangsan”,
			"password": “123456”,
			"photo": “/image/photo.jgp/”,
			"nickename": “张三”,
			"phone": “13331153369”,
			"p_id": 1,
			"d_id": 1
		}
	]
}
状态码描述
200退出成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
token:aabdncdhdbd878sbdudn898
请求报文:
{
	"token": "5qe6sd3dasdasdasd4a",
}
响应报文
{
	"code": 200,
	"data": [
		{
			"username": “zhangsan”,
			"password": “123456”,
			"photo": “/image/photo.jgp/”,
			"nickename": “张三”,
			"phone": “13331153369”,
			"p_id": 1,
			"d_id": 1
		},
		{
			"username": “zhangsan”,
			"password": “123456”,
			"photo": “/image/photo.jgp/”,
			"nickename": “张三”,
			"phone": “13331153369”,
			"p_id": 1,
			"d_id": 1
		},
		{
			"username": “zhangsan”,
			"password": “123456”,
			"photo": “/image/photo.jgp/”,
			"nickename": “张三”,
			"phone": “13331153369”,
			"p_id": 1,
			"d_id": 1
		}
	]
}

员工离职

接口功能

员工离职

URL

https://api.OAPro.com/v1/Staff/id/

支持格式

JSON

HTTP请求方式

DELETE

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string32用户名用户名不可以以数字开头
返回数据

数据格式

{
	"code": "200",
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
		"token": 5qe6sd3dasdasdasd4a"
	}
响应报文
{
	"code": 200,
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

职位管理

说明

商户类接口主要有添加职位、职位修改、职位删除、获取职位四个功能组成,负责商户对职位的管理和数据分析

添加职位

接口功能

添加职位

URL

https://api.OAPro.com/v1/Position/

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
app_id约束String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
p_name1String32店铺名称敏感词审核
p_description1类型长度描述取值说明
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"id": 1,
	"p_name": "董事长",
	"p_description": "董事长要懂事"
}
响应报文
{
	"code": 200,
	"data": {
		"id": 1,
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}

职位修改

接口功能

取消开店功能

URL

https://api.OAPro.com/v1/Position/p_id/

支持格式

JSON

HTTP请求方式

PUT

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
app_id约束String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
p_name1String32店铺名称敏感词审核
p_description1类型长度描述取值说明
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"id": 1,
	"p_name": "董事长",
	"p_description": "董事长要懂事"
}
响应报文
{
	"code": 200,
	"data": {
		"id": 1,
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}

职位删除

接口功能

职位删除

URL

https://api.OAPro.com//v1/Position/p_id/

支持格式

JSON

HTTP请求方式

DELETE

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
app_id约束String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
p_name1String32店铺名称敏感词审核
p_description1类型长度描述取值说明
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"id": 1,
	"p_name": "董事长",
	"p_description": "董事长要懂事"
}
响应报文
{
	"code": 200,
	"data": {
		"id": 1,
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}

获取职位

接口功能

获取职位

URL

https://api.OAPro.com/v1/Position/

支持格式

JSON

HTTP请求方式

GET

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
app_id约束String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
p_name1String32店铺名称敏感词审核
p_description1类型长度描述取值说明
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"id": 1,
	"p_name": "董事长",
	"p_description": "董事长要懂事"
}
响应报文
{
	"code": 200,
	"data": {
		"id": 1,
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}

职位信息展示

接口功能

店铺购进商品(必须是店主权限)

URL

https://api.OAPro.com/v1/Position/p_id/ GET Flask DRF

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
app_id约束String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
p_name1String32店铺名称敏感词审核
p_description1类型长度描述取值说明
token1String30校验必须校验通过才可以注册店铺
返回数据
数据格式
{
	"code": "200",
	"data": {
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"id": 1,
	"p_name": "董事长",
	"p_description": "董事长要懂事"
}
响应报文
{
	"code": 200,
	"data": {
		"id": 1,
		"p_name": "董事长",
		"p_description": "董事长要懂事"
	}
}

部门管理

说明

用户类结构一共包括:部门添加,部门信息修改,部门信息展示, 部门删除四个功能负责整个项目的部门管理

部门添加

接口功能

部门添加

URL

https://api.OAPro.com/v1/Department/

支持格式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
d_name1String32地址用户名不可以以数字开头
d_description1String32收货人密码必须有大小写字母或者字母数字
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"d_name":"财务部",
	"d_description":"管钱的部门"
}
响应报文
{
	"code": 200,
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}

部门信息修改

接口功能

部门信息修改

URL

https://api.OAPro.com/v1/Department/d_id/

支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
d_name1String32地址用户名不可以以数字开头
d_description1String32收货人密码必须有大小写字母或者字母数字
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"d_name":"财务部",
	"d_description":"管钱的部门"
}
响应报文
{
	"code": 200,
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}

部门删除

接口功能

部门删除

URL

https://api.OAPro.com/v1/Department/d_id/

支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
d_name1String32地址用户名不可以以数字开头
d_description1String32收货人密码必须有大小写字母或者字母数字
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"d_name":"财务部",
	"d_description":"管钱的部门"
}
响应报文
{
	"code": 200,
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}

部门信息展示

接口功能

商品功能

URL

https://api.OAPro.com/v1/Department/d_id/

支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
d_name1String32地址用户名不可以以数字开头
d_description1String32收货人密码必须有大小写字母或者字母数字
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	"d_name":"财务部",
	"d_description":"管钱的部门"
}
响应报文
{
	"code": 200,
	"data": {
		"d_name":"财务部",
		"d_description":"管钱的部门"
	}
}

考勤接口

用户类结构一共包括:考勤申请,考勤审批,考勤数据统计三个功能,负责整个项目的用户管理

URL
路由描述请求类型
https://api.OAPro.com/v1/Attendance/考勤申请POST
https://api.OAPro.com/v1/Attendance/a_id/考勤审批PUT
https://api.OAPro.com/v1/Attendance/date/考勤数据统计GET
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
user_id1int-请假id整形
a_type1String32假期类型事假,病假,婚假,产假
a_description1String32假条描述假条描述
a_time1time-请假时间YYYY-MM-DD
a_statue1int-请假状态整形
token1String30校验身份必须校验通过才可以获取数据
返回数据

数据格式

{
	"code": "200",
	"data": {
		“user_id”: 1,
		"a_type":"病假",
		"a_description":"阑尾炎,要消炎",
		"a_time":"1983-05-01",
		"a_statue":"通过",
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	“user_id”: 1,
	"a_type":"病假",
	"a_description":"阑尾炎,要消炎",
	"a_time":"1983-05-01",
	"a_statue":"通过",
}
响应报文
{
	"code": 200,
	"data": {
		“user_id”: 1,
		"a_type":"病假",
		"a_description":"阑尾炎,要消炎",
		"a_time":"1983-05-01",
		"a_statue":"通过",
	}
}

绩效接口

用户类结构一共包括:绩效申报,绩效审核,绩效展示三个功能,负责整个项目的用户管理

URL
路由描述请求类型
https://api.OAPro.com/v1/KPI/u_id/date/绩效申报POST
https://api.OAPro.com/v1/KPI/u_id/date/绩效审核PUT
https://api.OAPro.com/v1/KPI/u_id/date/绩效展示GET
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
user_id1int-用户id整形
kpi_value1Float-kpi值0<value<2
kpi_description1String32kpi描述kpi描述
kpi_time1time-kpi时间YYYY-MM-DD
kpi_statue1int-kpi状态整形
token1String30校验身份必须校验通过才可以获取数据
返回数据

数据格式

{
	"code": "200",
	"data": {
		“user_id”: 1,
		"kpi_value":"1.2",
		"kpi_description":"绩效描述",
		"kpi_time":"1983-05-01",
		"kpi_statue":1,
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	“user_id”: 1,
	"kpi_value":"1.2",
	"kpi_description":"绩效描述",
	"kpi_time":"1983-05-01",
	"kpi_statue":1,
}
响应报文
{
	"code": 200,
	"data": {
		“user_id”: 1,
		"kpi_value":"1.2",
		"kpi_description":"绩效描述",
		"kpi_time":"1983-05-01",
		"kpi_statue":1,
	}
}

权限接口

用户类结构一共包括:权限添加,权限分配,权限查看,权限删除,权限校验 五个功能,负责整个项目的用户管理

URL
路由描述请求类型
https://api.OAPro.com/v1/Permission/权限添加POST
https://api.OAPro.com/v1/Permission/p_id/权限分配PUT
https://api.OAPro.com/v1/Permission/权限查看GET
https://api.OAPro.com/v1/Permission/p_id/权限删除DELETE
https://api.OAPro.com/v1/Permission/p_id/权限校验GET
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
p_name1String32权限名称权限名称
p_description1Text-权限描述权限描述
token1String30校验身份必须校验通过才可以获取数据
返回数据

数据格式

{
	"code": "200",
	"data": {
		“p_name”: “进入首页”,
		"p_description":"获取该全权限,可以进入首页"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	“p_name”: “进入首页”,
	"p_description":"获取该全权限,可以进入首页"
}
响应报文
{
	"code": 200,
	"data": {
		“p_name”: “进入首页”,
		"p_description":"获取该全权限,可以进入首页"
	}
}

新闻接口

用户类结构一共包括:新闻发布,新闻查看,新闻修改,新闻删除,四个功能,负责整个项目的用户管理

URL
路由描述请求类型
https://api.OAPro.com/v1/New/新闻发布POST
https://api.OAPro.com/v1/New/n_id/新闻查看GET
https://api.OAPro.com/v1/New/n_id/新闻修改PUT
https://api.OAPro.com/v1/New/n_id/新闻删除DELETE
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
n_title1String32新闻标题新闻标题
n_author1String32作者作者
n_time1time-时间YYYY-MM-DD
n_content1Text-内容文本类型
token1String30校验身份必须校验通过才可以获取数据
返回数据

数据格式

{
	"code": "200",
	"data": {
		“n_title”: “十一放假通知”,
		"n_author":"事业部",
		"n_time": "1837-02-11",
		"n_content": "2016年10月1日至10月7日放假,共7天。
        			10月1日(星期六)、10月2日(星期日)、10月3日(星期一)为国庆节法定节假日
                    10月8号(星期六)、10月9号(星期天)公休调至10月4号(星期二),10月5号(星期三)     
                    10月8号(星期六)10月9号(星期天)正常上班。"
	}
}
状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息:
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文:
{
	“n_title”: “十一放假通知”,
	"n_author":"事业部",
	"n_time": "1837-02-11",
	"n_content": "2016年10月1日至10月7日放假,共7天。
        		  10月1日(星期六)、10月2日(星期日)、10月3日(星期一)为国庆节法定节假日
                  10月8号(星期六)、10月9号(星期天)公休调至10月4号(星期二),10月5号(星期三)     
                  10月8号(星期六)10月9号(星期天)正常上班。"
}
响应报文
{
	"code": 200,
	"data": {
		“n_title”: “十一放假通知”,
		"n_author":"事业部",
		"n_time": "1837-02-11",
		"n_content": "2016年10月1日至10月7日放假,共7天。
        			10月1日(星期六)、10月2日(星期日)、10月3日(星期一)为国庆节法定节假日
                    10月8号(星期六)、10月9号(星期天)公休调至10月4号(星期二),10月5号(星期三)     
                    10月8号(星期六)10月9号(星期天)正常上班。"
	}
}

周报接口

用户类结构一共包括:周考勤分析,月考勤分析,季度考勤分析,年考勤分析,个人KPI分析,部门KPI分析,公司KPI分析七个功能,负责整个项目的用户管理

周考勤分析 https://api.OAPro.com/v1/Attendance/week/ GET Flask DRF

月考勤分析 https://api.OAPro.com/v1/Attendance/month/ GET Flask DRF

季度考勤分析 https://api.OAPro.com/v1/Attendance/quarter/ GET Flask DRF

年考勤分析 https://api.OAPro.com/v1/Attendance/year/ GET Flask DRF

个人KPI分析 https://api.OAPro.com/v1/KPI/u_id/ GET Flask DRF

部门KPI分析 https://api.OAPro.com/v1/KPI/d_id/ GET Flask DRF

公司KPI分析 https://api.OAPro.com/v1/KPI/company/ GET Flask DRF

URL
路由描述请求类型
https://api.OAPro.com/v1/Attendance/week/周考勤分析GET
https://api.OAPro.com/v1/Attendance/month/月考勤分析GET
https://api.OAPro.com/v1/Attendance/quarter/季度考勤分析GET
https://api.OAPro.com/v1/Attendance/year/年考勤分析GET
https://api.OAPro.com/v1/KPI/u_id/个人KPI分析GET
https://api.OAPro.com/v1/KPI/d_id/部门KPI分析GET
https://api.OAPro.com/v1/KPI/company/公司KPI分析GET
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json