我们只梳理了比较重要的接口协议,其他如果需要请自行查看代码梳理协议
登录OA开发者平台(https://develp.OAPro.com),注册账号
开发网关地址 (https://api.OAPro.com/v1/UserInfo/)
测试网关地址(https://api.OAPro.com/t/)
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
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"
}
}
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
用户类结构一共包括:添加员工、修改员工、员工详情、员工列表、员工离职 五个功能,负责整个项目的职员管理
添加员工
https://api.OAPro.com/v1/Staff/
JSON
POST
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
username | 1 | string | 32 | 用户名 | 用户名不可以以数字开头 |
password | 1 | string | 32 | 密码 | 密码必须有大小写字母或者字母数字 |
photo | 1 | path | 头像 | 头像路径 | |
nickename | 1 | string | 32 | 实名 | 名字 |
phone | 1 | string | 32 | 电话 | 大陆+86 11位电话号 |
p_id | 1 | int | 职位id | 外键 | |
d_id | 1 | int | 部门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
}
}
修改员工
https://api.OAPro.com/v1/Staff/id/
JSON
PUT
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
username | 1 | string | 32 | 用户名 | 用户名不可以以数字开头 |
password | 1 | string | 32 | 密码 | 密码必须有大小写字母或者字母数字 |
photo | 1 | path | 头像 | 头像路径 | |
nickename | 1 | string | 32 | 实名 | 名字 |
phone | 1 | string | 32 | 电话 | 大陆+86 11位电话号 |
p_id | 1 | int | 职位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
}
}
员工详情
https://api.OAPro.com/v1/Staff/id/
JSON
GET
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
username | 1 | string | 32 | 用户名 | 用户名不可以以数字开头 |
password | 1 | string | 32 | 密码 | 密码必须有大小写字母或者字母数字 |
photo | 1 | path | 头像 | 头像路径 | |
nickename | 1 | string | 32 | 实名 | 名字 |
phone | 1 | string | 32 | 电话 | 大陆+86 11位电话号 |
p_id | 1 | int | 职位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
}
}
员工列表
https://api.OAPro.com/v1/Staff/
JSON
GET
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
token | 1 | string | - | 校验数据 | 平台下发 |
数据格式
{
"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
}
]
}
员工离职
https://api.OAPro.com/v1/Staff/id/
JSON
DELETE
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
token | 1 | string | 32 | 用户名 | 用户名不可以以数字开头 |
数据格式
{
"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": "北京市朝阳区五方桥"
}
}
商户类接口主要有添加职位、职位修改、职位删除、获取职位四个功能组成,负责商户对职位的管理和数据分析
添加职位
https://api.OAPro.com/v1/Position/
JSON
POST
参数名称 | 参数值 |
---|---|
content-Type | application/json |
app_id | 约束 | String | 36 | 应用ID | 通过添加应用生成 |
---|---|---|---|---|---|
sign | 1 | String | - | 签名 | 请参考签名说明 |
p_name | 1 | String | 32 | 店铺名称 | 敏感词审核 |
p_description | 1 | 类型 | 长度 | 描述 | 取值说明 |
token | 1 | String | 30 | 校验 | 必须校验通过才可以注册店铺 |
数据格式
{
"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": "董事长要懂事"
}
}
取消开店功能
https://api.OAPro.com/v1/Position/p_id/
JSON
PUT
参数名称 | 参数值 |
---|---|
content-Type | application/json |
app_id | 约束 | String | 36 | 应用ID | 通过添加应用生成 |
---|---|---|---|---|---|
sign | 1 | String | - | 签名 | 请参考签名说明 |
p_name | 1 | String | 32 | 店铺名称 | 敏感词审核 |
p_description | 1 | 类型 | 长度 | 描述 | 取值说明 |
token | 1 | String | 30 | 校验 | 必须校验通过才可以注册店铺 |
数据格式
{
"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": "董事长要懂事"
}
}
职位删除
https://api.OAPro.com//v1/Position/p_id/
JSON
DELETE
参数名称 | 参数值 |
---|---|
content-Type | application/json |
app_id | 约束 | String | 36 | 应用ID | 通过添加应用生成 |
---|---|---|---|---|---|
sign | 1 | String | - | 签名 | 请参考签名说明 |
p_name | 1 | String | 32 | 店铺名称 | 敏感词审核 |
p_description | 1 | 类型 | 长度 | 描述 | 取值说明 |
token | 1 | String | 30 | 校验 | 必须校验通过才可以注册店铺 |
数据格式
{
"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": "董事长要懂事"
}
}
获取职位
https://api.OAPro.com/v1/Position/
JSON
GET
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 参数值 |
---|---|
content-Type | application/json |
app_id | 约束 | String | 36 | 应用ID | 通过添加应用生成 |
---|---|---|---|---|---|
sign | 1 | String | - | 签名 | 请参考签名说明 |
p_name | 1 | String | 32 | 店铺名称 | 敏感词审核 |
p_description | 1 | 类型 | 长度 | 描述 | 取值说明 |
token | 1 | String | 30 | 校验 | 必须校验通过才可以注册店铺 |
数据格式
{
"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": "董事长要懂事"
}
}
店铺购进商品(必须是店主权限)
https://api.OAPro.com/v1/Position/p_id/ GET Flask DRF
JSON
POST
参数名称 | 参数值 |
---|---|
content-Type | application/json |
app_id | 约束 | String | 36 | 应用ID | 通过添加应用生成 |
---|---|---|---|---|---|
sign | 1 | String | - | 签名 | 请参考签名说明 |
p_name | 1 | String | 32 | 店铺名称 | 敏感词审核 |
p_description | 1 | 类型 | 长度 | 描述 | 取值说明 |
token | 1 | String | 30 | 校验 | 必须校验通过才可以注册店铺 |
{
"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": "董事长要懂事"
}
}
用户类结构一共包括:部门添加,部门信息修改,部门信息展示, 部门删除四个功能负责整个项目的部门管理
部门添加
https://api.OAPro.com/v1/Department/
POST
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
d_name | 1 | String | 32 | 地址 | 用户名不可以以数字开头 |
d_description | 1 | String | 32 | 收货人 | 密码必须有大小写字母或者字母数字 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以注册店铺 |
数据格式
{
"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":"管钱的部门"
}
}
部门信息修改
https://api.OAPro.com/v1/Department/d_id/
JSON
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
d_name | 1 | String | 32 | 地址 | 用户名不可以以数字开头 |
d_description | 1 | String | 32 | 收货人 | 密码必须有大小写字母或者字母数字 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以注册店铺 |
数据格式
{
"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":"管钱的部门"
}
}
部门删除
https://api.OAPro.com/v1/Department/d_id/
JSON
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
d_name | 1 | String | 32 | 地址 | 用户名不可以以数字开头 |
d_description | 1 | String | 32 | 收货人 | 密码必须有大小写字母或者字母数字 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以注册店铺 |
数据格式
{
"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":"管钱的部门"
}
}
商品功能
https://api.OAPro.com/v1/Department/d_id/
JSON
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
req_time | 1 | String | - | 请求时间 | YYYY-MM-DD |
d_name | 1 | String | 32 | 地址 | 用户名不可以以数字开头 |
d_description | 1 | String | 32 | 收货人 | 密码必须有大小写字母或者字母数字 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以注册店铺 |
数据格式
{
"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":"管钱的部门"
}
}
用户类结构一共包括:考勤申请,考勤审批,考勤数据统计三个功能,负责整个项目的用户管理
路由 | 描述 | 请求类型 |
---|---|---|
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
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
user_id | 1 | int | - | 请假id | 整形 |
a_type | 1 | String | 32 | 假期类型 | 事假,病假,婚假,产假 |
a_description | 1 | String | 32 | 假条描述 | 假条描述 |
a_time | 1 | time | - | 请假时间 | YYYY-MM-DD |
a_statue | 1 | int | - | 请假状态 | 整形 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以获取数据 |
数据格式
{
"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":"通过",
}
}
用户类结构一共包括:绩效申报,绩效审核,绩效展示三个功能,负责整个项目的用户管理
路由 | 描述 | 请求类型 |
---|---|---|
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
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
user_id | 1 | int | - | 用户id | 整形 |
kpi_value | 1 | Float | - | kpi值 | 0<value<2 |
kpi_description | 1 | String | 32 | kpi描述 | kpi描述 |
kpi_time | 1 | time | - | kpi时间 | YYYY-MM-DD |
kpi_statue | 1 | int | - | kpi状态 | 整形 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以获取数据 |
数据格式
{
"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,
}
}
用户类结构一共包括:权限添加,权限分配,权限查看,权限删除,权限校验 五个功能,负责整个项目的用户管理
JSON
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
p_name | 1 | String | 32 | 权限名称 | 权限名称 |
p_description | 1 | Text | - | 权限描述 | 权限描述 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以获取数据 |
数据格式
{
"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":"获取该全权限,可以进入首页"
}
}
用户类结构一共包括:新闻发布,新闻查看,新闻修改,新闻删除,四个功能,负责整个项目的用户管理
路由 | 描述 | 请求类型 |
---|---|---|
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
参数名称 | 参数值 |
---|---|
content-Type | application/json |
参数名称 | 约束 | 类型 | 长度 | 描述 | 取值说明 |
---|---|---|---|---|---|
app_id | 1 | String | 36 | 应用ID | 通过添加应用生成 |
sign | 1 | String | - | 签名 | 请参考签名说明 |
n_title | 1 | String | 32 | 新闻标题 | 新闻标题 |
n_author | 1 | String | 32 | 作者 | 作者 |
n_time | 1 | time | - | 时间 | YYYY-MM-DD |
n_content | 1 | Text | - | 内容 | 文本类型 |
token | 1 | String | 30 | 校验身份 | 必须校验通过才可以获取数据 |
数据格式
{
"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
路由 | 描述 | 请求类型 |
---|---|---|
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
参数名称 | 参数值 |
---|---|
content-Type | application/json |