管理API对接文档（2024版）

最近更新时间：


接口说明

说明
  • 用于查询员工角色信息

基本信息

HTTP URL

/river/Role/get

HTTP Method

GET

权限要求


请求头

参数名称

参数值

Content-Type

application/x-www-form-urlencoded

请求参数

字段名

字段说明

字段类型

必填

备注

client_id

申请应用时分配的AppKey

string

Y


access_token

授权后的access token

string

Y


company_id

公司 ID

string

Y


timestamp

当前时间戳

bigint

Y


sign

签名

string

Y



请求示例

curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/river/Role/get?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552&timestamp=1566764837&company_id=12345678980&sign=091cf244ad5ab16935cfe44fc698bc58

响应参数

字段名

字段说明

字段类型

备注

errno

0表示成功，非0表示失败

int


errmsg

errno=0时为常量"SUCCESS"，errno!=0时为错误信息

string


data

角色数组

array







data数组元素格式

字段名

字段说明

字段类型

备注

id

角色ID

string


name

角色中文名称

string


alias

角色英文别名

string




响应示例

正常示例

{
    "errno":0,
    "errmsg":"SUCCESS",
    "data":[
        {
            "id":"1235901681377206",
            "name":"超级管理员",
            "alias":"system_super_admin"
        }

    ]
}

异常示例


错误码

通用错误解决方案

  1. 4xx 错误
  2. 1xxx 错误


版本记录

日期

更新人

更新内容

上线时间

2023.11.14

陈继诗

迁移文档