API Exploration
Prerequisites: First read ../ziniao-shared/SKILL.md。
When the user's requirementcannot be covered by existing shortcut commands, use this skill to find the corresponding API path and call it directly through ziniao-cli api .
Exploration Process
Step 1: Confirm Existing Commands Are Insufficient
ziniao-cli department --help
ziniao-cli staff --help
ziniao-cli account --help
ziniao-cli device --help
ziniao-cli role --help
If a corresponding shortcut command already exists, use it directly.
Step 2: Locate the API from the Path List
Guessing API paths is prohibited; you must look them up from the following list.
Departments (5) ✅ All already have shortcut commands
| Operation |
Path |
Shortcut Command |
| List |
/superbrowser/rest/v1/erp/department/list |
department list |
| Add |
/superbrowser/rest/v1/erp/department/add |
department create |
| Update |
/superbrowser/rest/v1/erp/department/update |
department update |
| Delete |
/superbrowser/rest/v1/erp/department/delete |
department delete |
| Sort |
/superbrowser/rest/v1/erp/department/order |
department reorder |
Employees (5) ✅ All already have shortcut commands
| Operation |
Path |
Shortcut Command |
| List |
/superbrowser/rest/v1/erp/staff/list |
staff list |
| Add |
/superbrowser/rest/v2/erp/staff/add |
staff create |
| Update |
/superbrowser/rest/v2/erp/staff/modify |
staff update |
| Status |
/superbrowser/rest/v1/erp/staff/status |
staff enable/disable/remove |
| Transfer |
/superbrowser/rest/v1/erp/staff/department |
staff transfer |
Accounts (23) — 4 still require api
| Category |
Path Prefix |
Shortcut Command |
| CRUD |
/superbrowser/rest/v1/erp/store/list|create|update/base|delete |
account list/create/update/delete |
| Cache |
/superbrowser/rest/v1/erp/store/deletecookie |
api |
| Authorization |
/superbrowser/rest/v1/erp/store/auth/add|delete|clean、/superbrowser/rest/v1/erp/user/stores、/superbrowser/rest/v1/erp/store/user/list |
account auth-* |
| Authorization Query |
/superbrowser/rest/v1/erp/store/auth/query |
api |
| User Account |
/superbrowser/rest/v1/erp/store/list/by/user |
api |
| Additional Information |
/superbrowser/rest/v1/erp/store/addtion |
api |
| Tags |
/superbrowser/rest/v1/erp/tag/list、/superbrowser/rest/v1/store-tag/add|delete|rename|bind|unbind|replace|clear|remove|list |
account tag-* |
Devices (11) — 2 still require api
| Category |
Path Prefix |
Shortcut Command |
| Query |
/superbrowser/rest/v1/erp/ip/page、/superbrowser/rest/v1/erp/proxy/purchased_package_info、/superbrowser/rest/v1/erp/ip/historybind |
device list(price/history uses api） |
| Plan |
/superbrowser/rest/v1/erp/package/new |
device plan-list |
| Purchase |
/superbrowser/rest/v1/erp/purchase|renew |
device purchase/renew |
| Owned |
/superbrowser/rest/v1/erp/ip/self/add/new|edit/new |
device add-custom/update-custom |
| Binding |
/superbrowser/rest/v1/erp/ip/bind|unbind|renewal |
device bind/unbind/auto-renew |
Roles (7) ✅ All already have shortcut commands
| Operation |
Path |
Shortcut Command |
| List |
/superbrowser/rest/v1/erp/per/role/list |
role list |
| Details |
/superbrowser/rest/v1/erp/per/role/detail |
role detail |
| Add |
/superbrowser/rest/v1/erp/per/role/add |
role create |
| Update |
/superbrowser/rest/v1/erp/per/role/edit |
role update |
| Assign |
/superbrowser/rest/v1/erp/staff/change/role |
role assign |
| User Roles |
/superbrowser/rest/v1/erp/staff/role/list |
role staff-roles |
| Permission List |
/superbrowser/rest/v1/erp/per/permission/list |
role permissions |
Access Policies (22) — All require api
| Category |
Path |
| Rule |
/superbrowser/rest/v1/erp/security/access_rule/list |
| Rule |
/superbrowser/rest/v1/erp/security/access_rule/detail |
| Rule |
/superbrowser/rest/v1/erp/security/access_rule/add |
| Rule |
/superbrowser/rest/v1/erp/security/access_rule/edit |
| Rule |
/superbrowser/rest/v1/erp/security/access_rule/delete |
| Rule |
/superbrowser/rest/v1/erp/security/access_rule/active |
| Rule Member |
/superbrowser/rest/v1/erp/security/access_rule/change_user |
| Rule Account |
/superbrowser/rest/v1/erp/security/access_rule/change_account |
| Rule Account |
/superbrowser/rest/v1/erp/security/access_rule/account/bindable_list |
| Webpage |
/superbrowser/rest/v1/erp/security/access_rule_url/list |
| Webpage |
/superbrowser/rest/v1/erp/security/access_rule_url/detail |
| Webpage |
/superbrowser/rest/v1/erp/security/access_rule_url/add |
| Webpage |
/superbrowser/rest/v1/erp/security/access_rule_url/edit |
| Webpage |
/superbrowser/rest/v1/erp/security/access_rule_url/delete |
| Webpage |
/superbrowser/rest/v1/erp/security/access_rule_url/change_group |
| Webpage Group |
/superbrowser/rest/v1/erp/security/access_rule_url_group/list |
| Webpage Group |
/superbrowser/rest/v1/erp/security/access_rule_url_group/add |
| Webpage Group |
/superbrowser/rest/v1/erp/security/access_rule_url_group/edit |
| Webpage Group |
/superbrowser/rest/v1/erp/security/access_rule_url_group/delete |
| Account Policy |
/superbrowser/rest/v1/erp/security/access_rule/list/one_account |
| Account Policy |
/superbrowser/rest/v1/erp/security/access_rule/account_ref/add_to_account |
| Account Policy |
/superbrowser/rest/v1/erp/security/access_rule/account_ref/remove_from_account |
Step 3: Use dry-run to Explore
# 先预览请求
ziniao-cli api /superbrowser/rest/v1/erp/per/role/list --dry-run
# 确认后执行
ziniao-cli api /superbrowser/rest/v1/erp/per/role/list
Safety Rules
- Guessing API paths or parameters is prohibited; you must look them up from the list
- Confirm user intent before write/delete operations
- It is recommended to first use
--dry-run to preview
Reference
