Administrator API

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/info

4.2、Request Params

Field	Type	Option	Description
account	String	No	Login account
password	String	No	Login password
confirm_password	String	No	Confirm password
name	String	Yes	If no name, use account by default
permission	List	No

4.3、Request Example

{
  "account": "Aministrator name",
  "password": "123456",
  "config_password": "123456",
  "name": "nickname",
  "permission": [
    {
      "parent_id": "",
      "permission_id": "",
      "name": ""
    }
  ]
}

4.4、Response

Field	Type	Description
admin_id	String	Administrator id

4.5、Response example

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

5、Update Administrator Information

5.1、Request Type and Url

PUT /api/v1/user/admin/info

5.2、Request Params

Field	Type	Option	Description
admin_id	int	No	Administrator id
account	String	Yes	Login account. if empty, not update.
password	String	Yes	Login password. if empty, not update.
confirm_password	String	Yes	Confirm password.
name	String	Yes	If empty, not updated.

5.3、Request Example

{
  "admin_id": 1,
  "account": "Aministrator name",
  "password": "123456",
  "config_password": "123456",
  "name": "nickname",
  "permission": [
    {
      "parent_id": "",
      "permission_id": "",
      "name": ""
    }
  ]
}

5.4、Response

Field	Type	Description
admin_id	String	Administrator id

5.5、Response example

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

6、Delete Administrator

6.1、Request Type and Url

DELETE /api/v1/user/admin/info

6.2、Request Params

Field	Type	Option	Description
admin_id	String/List	No	Administrator id

6.3、Request Example

{
  "admin_id": 1
}

or

{
  "admin_id": [1, 2, 3]
}

6.4、Response

Field	Type	Description

6.5、Response example

{
    "code": 0,
    "msg": "success"
}

7、Update Administrator Status

7.1、Request Type and Url

PUT /api/v1/user/admin/status

7.2、Request Params

Field	Type	Option	Description
admin_id	String/List	No	Administrator id
status	int	No	Value 1 normal, -1 forbidden

7.3、Request Example

{
  "admin_id": 1,
  "status": 1
}

or

{
  "admin_id": [1, 2, 3],
  "status": 1
}

7.4、Response

Field	Type	Description

7.5、Response example

{
    "code": 0,
    "msg": "success"
}

8、Query Administrator Detail

8.1、Request Type and Url

GET /api/v1/user/admin/info

8.2、Request Params

Field	Type	Option	Description
admin_id	String	No	Administrator id

8.3、Request Example

{
  "admin_id": 1
}

8.4、Response

Field	Type	Description
admin_id	String	Administrator id
account	String	Login account
name	String	Nickname
permission	List	Permission tree

8.5、Response example

{
    "code": 0,
    "msg": "success",
  	"data": {
      "admin_id": "Administrator id",
      "account": "",
      "name": "",
      "permission": []
    }
}