Device App Access Points
ManageThedeviceDeviceapplicationApp Access Points API provides access to manage and retrieve access point information within the GATE system. This endpoint allows you to query access points with filtering and pagination capabilities, making it essential for network infrastructuremonitoringmanagement andcontrol.monitoring applications.
Base URL: https://gate.zequenze.com/api/v1
Authentication: All endpoints require a Bearer token:
Authorization: Bearer <your-api-token>
Overview
The Device App Access Points API is designed for managing wireless access points and network infrastructure devices within your organization's GATE system. This API category enables developers to retrieve comprehensive information about access points, including their configuration, status, and operational data.
Key Features:
Common Use Cases:
The API follows RESTful principles and returns data in JSON format, making it easy to integrate with modern web applications and monitoring tools. All responses include pagination metadata to help you efficiently handle large datasets of access points.
Endpoints
GET /device_app_access_points/
RetrieveDescription: Retrieves a paginated list of device application access points withfrom optionalthe filteringGATE system. This endpoint allows you to fetch comprehensive information about wireless access points, including their current status, configuration details, and pagination.metadata. You can filter results by modification date and control pagination through limit and offset parameters.
Use Cases:
Full URL Example:
https://gate.zequenze.com/api/v1/device_app_access_points/?limit=20&offset=0&last_change__gte=2024-01-01T00:00:00Z
Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| last_change__gte | string | query | No | Filter access points modified on or after this |
| limit | integer | query | No | Number of results to return per page (default varies, typically 20-100) |
| offset | integer | query | No | The initial index from which to return |
ExamplecURL Request:Example:
curl -X GET "https://gate.zequenze.com/api/v1/device_app_access_points/?limit=10&last_change__gte=2024-01-01T00:15T00:00:00Z&limit=50&offset=000Z" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Example Response:
{
"count": 125,145,
"next": "https://gate.zequenze.com/api/v1/device_app_access_points/?limit=5010&offset=50"10",
"previous": null,
"results": [
{
"id": 1,
"name": "Main Building WiFi"AP-Floor1-East",
"device_id"mac_address": "dev_001",
"app_name": "WifiManager",
"access_point_type": "wireless",
"status": "active"AA:BB:CC:DD:EE:FF",
"ip_address": "192.168.1.100"101",
"mac_address"status": "00:1B:44:11:3A:B7"online",
"signal_strength": -45,
"connected_devices": 23,
"bandwidth_limit"location": "100Mbps"Building A - Floor 1 East Wing",
"security_protocol"model": "WPA3"Cisco AIR-AP2802I-E-K9",
"last_change"firmware_version": "8.10.185.0",
"ssid_count": 3,
"connected_clients": 24,
"uptime": "15d 4h 32m",
"last_seen": "2024-01-15T14:30:00Z",
"last_change": "2024-01-15T10:15:00Z",
"organization": "Main Office",
"zone": "Corporate Network",
"signal_strength": -45,
"channel": 6,
"bandwidth": "80MHz",
"power_consumption": 12.5,
"temperature": 42.3,
"created_at": "2023-12-01T10:2024-01-01T08:00:00Z",
"updated_at": "2024-01-15T14:30:15T10:15:00Z"
},
{
"id": 2,
"name": "Guest Network AP"AP-Lobby-Main",
"device_id"mac_address": "dev_002",
"app_name": "WifiManager",
"access_point_type": "guest_wireless",
"status": "active"11:22:33:44:55:66",
"ip_address": "192.168.2.50"1.102",
"mac_address"status": "00:1B:44:11:3A:C8"offline",
"signal_strength": -52,
"connected_devices": 8,
"bandwidth_limit"location": "50Mbps"Building A - Main Lobby",
"security_protocol"model": "WPA2"Cisco AIR-AP2802I-E-K9",
"firmware_version": "8.10.185.0",
"ssid_count": 2,
"connected_clients": 0,
"uptime": "0d 0h 0m",
"last_seen": "2024-01-14T16:45:00Z",
"last_change": "2024-01-14T09:15:14T16:45:00Z",
"organization": "Main Office",
"zone": "Guest Network",
"signal_strength": null,
"channel": 11,
"bandwidth": "40MHz",
"power_consumption": 0,
"temperature": null,
"created_at": "2023-12-01T10:2024-01-01T08:00:00Z",
"updated_at": "2024-01-14T09:15:14T16:45:00Z"
}
]
}
Response Codes:
| Status | Description |
|---|---|
| 200 | |
| 401 | Unauthorized - Invalid or missing |
| 403 | Forbidden - Insufficient permissions to access access points |
Common Use Cases
Use Case 1: Network Health Monitoring Dashboard
Create a real-time dashboard showing the status of all access points. Use the endpoint without filters to get all access points, then periodically refresh with last_change__gte set to the last update time to fetch only changed devices.
Use Case 2: Infrastructure Change Tracking
Monitor changes to your network infrastructure by calling the endpoint with last_change__gte parameter set to track modifications since your last check. This is useful for compliance reporting and change management.
Use Case 3: Capacity Planning and Analytics
Retrieve all access points to analyze client distribution, identify high-traffic areas, and plan network capacity upgrades based on connected client counts and signal strength data.
Use Case 4: Automated Alerting System
Implement monitoring that periodically fetches access point data to identify offline devices, overheating units, or access points with unusually low client counts that might indicate connectivity issues.
Use Case 5: Third-Party System Integration
Synchronize access point inventory and status with external network management systems, CMDB tools, or asset management platforms using pagination to handle large numbers of devices efficiently.
Best Practices
-
Pagination Strategy: Use
paginationappropriateparameters (limitvalues (20-100) to balance performance and memory usage. Always handle pagination by following theoffsetnext)whenURLdealinginwithresponses for largedatasetsdatasets.to improve performance ImplementtheEfficient Filtering: Use
last_change__gtefilterparameter for incrementalsynchronizationupdatestoratheronlythanfetchfetchingrecentlyallmodifieddataaccessrepeatedly.pointsStore the timestamp of your last successful request and use it for subsequent calls.MonitorrateError
limitsHandling:and implement appropriateImplement retry logic for 5xx errors with exponentialbackoffbackoff. For 401/403 errors, refresh your authentication token. Handle 422 errors by validating your query parameters.-
Rate Limiting: Implement appropriate delays between requests to avoid overwhelming the API. Monitor response headers for any rate limiting information.
Data Caching: Cache frequentlyaccess accessedpoint data locally and use the filtering parameters to reduceupdate only changed records, reducing API calls and improveimproving application responsivenessperformance.
Security: Always validateuse the response status code before processing the data