API Documentation

Version: 2.21.0
Base URL: https://your-domain.com

Overview

This documentation covers all available API endpoints for the Zal Ultra ISP Management System. All authenticated endpoints require a Bearer token in the Authorization header.

Authentication

Most endpoints require authentication using a Bearer token. Include the token in your request headers:

Authorization: Bearer your-auth-token

Common Headers

Header	Value	Description
Accept	application/json	Required for all requests
Content-Type	application/json	Required for POST/PUT requests

Common Query Parameters

Most authenticated endpoints require the following query parameters:

Parameter	Type	Description
isp_id	integer	ISP identifier
branch_id	integer	Branch identifier
user_id	integer	User identifier

Environment Variables

Variable	Description
zalultra_url	Base URL of the Zal Ultra API server
zalultra_token	Admin/Staff authentication token
subscriber_token	Subscriber authentication token
zalultra_email	Admin login email
zalultra_password	Admin login password
zalultra_sub_username	Subscriber login username
zalultra_sub_password	Subscriber login password

API Sections

Public

• Public Settings - Public endpoints (no auth required)

Authentication

• User Auth - Admin/Staff login, logout, token refresh
• Subscriber Auth - Subscriber login, logout

Subscriber Portal

• Subscriber Portal - Subscriber self-service endpoints

User (Admin) Endpoints

• Subscribers - Subscriber management
• Invoices - Invoice management
• Payments - Payment management
• Ledgers - Ledger management
• Users - User management
• Packages - Package management
• Dashboard - Dashboard statistics
• Settings - System settings
• OLT/ONU - Fiber network devices
• Policies - RADIUS policies
• Extra Fees - Extra fee management
• Bandwidth - Bandwidth allocations
• NAS - Network Access Servers
• IP Pools - IP pool management
• Areas - Area management
• Tickets - Support tickets
• Roles - Role management
• Permissions - Permission management
• Notes - Notes management
• Notices - Notice management
• Email Templates - Email templates
• SMS Templates - SMS templates
• Activity Logs - Activity logs
• ISPs - ISP management
• Branches - Branch management
• Inventory - Inventory management
• Expenses - Expense management
• MAC Binding - MAC address binding
• Reports - Reporting endpoints
• RADIUS - RADIUS management
• SMS - SMS messaging
• Balance - Balance management

Payment Gateways

• Payment Gateways - Bkash integration