Appearance
User (Admin/Staff) API
Base URL:
https://your-domain.com
Authentication: Bearer Token (Admin/Staff)
All endpoints in this section require admin/staff authentication. Include the Bearer token in your request headers.
API Modules
Core Management
| Module | Description | Endpoints |
|---|---|---|
| 📁 Subscribers | Subscriber CRUD, activation, suspension, import/export | 9 |
| 📁 Users | User management, resellers, staff | 7 |
| 📁 Packages | Package CRUD, assignment, pricing | 7 |
Accounting
| Module | Description | Endpoints |
|---|---|---|
| 📁 Invoices | Invoice CRUD, generate, pay, reverse | 8 |
| 📁 Payments | Payment CRUD, payment methods | 6 |
| 📁 Ledgers | Ledger history and transactions | 3 |
| 📁 Balance | Subscriber/user balance management | 4 |
| 📁 Expenses | Expense tracking and categories | 6 |
Network
| Module | Description | Endpoints |
|---|---|---|
| 📁 NAS | Network Access Server management | 6 |
| 📁 IP Pools | IP pool management and generation | 6 |
| 📁 OLT/ONU | Fiber network device management | 8 |
| 📁 Policies | RADIUS policy management | 5 |
| 📁 Bandwidth | Bandwidth allocation management | 6 |
| 📁 MAC Binding | MAC address binding | 4 |
| 📁 RADIUS | RADIUS sessions and management | 7 |
Organization
| Module | Description | Endpoints |
|---|---|---|
| 📁 ISPs | ISP management | 5 |
| 📁 Branches | Branch management | 5 |
| 📁 Areas | Area hierarchy management | 6 |
| 📁 Inventory | Inventory tracking and assignment | 7 |
Support & Communication
| Module | Description | Endpoints |
|---|---|---|
| 📁 Tickets | Support ticket management | 7 |
| 📁 Notes | Note management | 5 |
| 📁 Notices | Notice management | 5 |
| 📁 SMS | SMS messaging | 3 |
| 📁 SMS Templates | SMS template management | 5 |
| 📁 Email Templates | Email template management | 5 |
System
| Module | Description | Endpoints |
|---|---|---|
| 📁 Dashboard | Dashboard statistics and charts | 2 |
| 📁 Settings | System settings management | 6 |
| 📁 Roles | Role management | 6 |
| 📁 Permissions | Permission management | 2 |
| 📁 Activity Logs | Activity log viewing | 4 |
| 📁 Reports | Reporting endpoints | 6 |
| 📁 Extra Fees | Extra fee management | 6 |
Common Request Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer your-auth-token | Yes |
Accept | application/json | Yes |
Content-Type | application/json | Yes (POST/PUT) |
Common Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
isp_id | integer | Yes | ISP identifier |
branch_id | integer | Yes | Branch identifier |
user_id | integer | Yes | User identifier |
Method Reference
- GET - Retrieve data
- POST - Create new resource or perform action
- PUT - Update existing resource
- DELETE - Delete resource
Fields marked in red are required.
