服务端API



创建企业

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/company/create
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
company_name String 是 企业名称,1-50位字符串
mobile Int 是 创建人手机号(仅支持国内手机号),系统以此手机号创建成员账号,并设为该企业超级管理员,同手机号最多创建10个企业
user_name String 是 创建人用户名称,长度限制为1~64个字符,不允许包含字符‘-’‘,’以及‘,’
user_id String 否 成员企业内唯一标识ID,1-36位字符串,同一企业内user_id不能重复,不传则系统自动生成
position String 否 创建人职位
industry String 否 所属行业
scale Int 否 规模 1:50人以下 2:50-100人 3:100-500人 4:500-1000人 5:1000人以上
province_name String 否 所在省份
city_name String 否 所在城市
logo String 否 Logo完整URL,如https://xxx.com/1.png


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "company_id":"SOKEmYPTne1693552890", //企业ID,目前为20位,设计最大长度64位
    }
}



企业下单

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/company/createOrder
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
buy_corp_id String 是 购买企业ID
buy_corp_name String 是 购买企业名称
order_id String 是 订单ID,最大长度64字符
order_type String 是 订单类型 ,可选值有:BUY【新购】,RENEW【续费】
goods_code String 是 购买的商品码,可选值:由授客提供,请与授客商务合作代表沟通获取
item_code String 是 购买的规格码,可选值:由授客提供,请与授客商务合作代表沟通获取
sub_quantity Int 是 订单购买人数
pay_fee Int 是 支付金额,单位分
paid_time Int 是 实际支付时间,时间戳,单位秒
service_start_time Int 是 订单服务实际生效时间,时间戳,单位秒
service_stop_time Int 是 订单服务到期时间,时间戳,单位秒

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



企业取消订单

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/company/cancelOrder
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
buy_corp_id String 是 购买企业ID
order_id String 是 订单ID,最大长度64字符 (退订订单也需要下单,这是一个新的订单id)
cancel_order_id String 是 退订订单id (需要退订订单的id)

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}

企业修改logo

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/company/updateLogo
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
logo String 是 企业logo,传入一个可以在线浏览的url地址

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



企业管理员列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/oa/companyUser/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": [
        {
            "dept_user_id": "SOKEC0FC-C447-408F-BC7D-268D8BE78E98",
            "dept_user_name": "比得",
            "is_super": 1,
            "level": 1
        }
    ]
}

参数说明:

参数 类型 说明
data Array 返回的数据包
dept_user_id String 用户ID,同company_id组织内唯一,最大长度64字符
dept_user_name String 用户名,最大长度100字符
is_super Int 是否是超级管理员:
0 否
1 是
level Int 管理员级别:
1 主管理员
2 子管理员