Skip to content

Administrator API

唯一 edited this page Jun 1, 2020 · 12 revisions

1、Administrator Registration

1.1、Request Type and Url

POST /api/v1/user/admin/auth/register

1.2、Request Params

Field Type Option Description
account String No account. email or mobile
password String No password. 6-20 length
confirm_password String No confirm password

1.3、Request Example

{
  "account": "mail@example.com",
  "password": "123456",
  "confirm_password": "123456"
}

1.4、Response

Field Type Description
admin_id String administrator id

1.5、Response example

{
    "code": 0,
    "msg": "success",
    "data": {
        "admin_id": "131"
    }
}

2、Administrator Login (JWT Access Token)

2.1、Request Type and Url

POST /api/v1/user/admin/auth/jwt/token

2.2、Request Params

Field Type Option Description
account String No account. email or mobile
password String No password

2.3、Request Example

{
  "account": "mail@example.com",
  "password": "123456"
}

2.4、Response

Field Type Description
access_token String
expires_in Int access_token expiration time,unit second
refresh_expires_in Int refresh access_token expiration time, unit second

2.5、Response example

{
    "code": 0,
    "msg": "success",
    "data": {
        "access_token": "JWT Access Token",
        "expires_in": 7200,
        "refresh_expires_in": 2592000
    }
}

3、Query Administrators

3.1、Request Type and Url

GET /api/v1/user/admin/page

3.2、Request Params

Field Type Option Description
search_key String Yes
status int Yes Administrator status id, 1 normal, -1 forbidden
page_index Int Yes Default 1
page_size Int Yes Default 15

3.3、Request Example

{
  "search_key": "Aministrator name",
  "status": 1,
  "page_index": 1,
  "page_size": 100
}

3.4、Response

Field Type Description
access_token String
expires_in Int access_token expiration time,unit second
refresh_expires_in Int refresh access_token expiration time, unit second

3.5、Response example

{
    "code": 0,
    "msg": "success",
    "data": {
        "access_token": "JWT Access Token",
        "expires_in": 7200,
        "refresh_expires_in": 2592000
    }
}

4、Create New Administrator

4.1、Request Type and Url

POST /api/v1/user/admin/create

4.2、Request Params

Field Type Option Description
search_key String Yes
status Int Yes Administrator status id, 1 normal, -1 forbidden
page_index Int Yes Default 1
page_size Int Yes Default 15

4.3、Request Example

{
  "account": "Aministrator name",
  "password": "123456",
  "config_password": "123456",
  "name": "nickname"
}

4.4、Response

Field Type Description
admin_id String Administrator id

4.5、Response example

{
    "code": 0,
    "msg": "success",
    "data": {
        "admin_id": "Administrator id"
    }
}

Clone this wiki locally