Device App Access Points
The Device App Access Points API provides
accessendpointstoformanagemanaging andretrieveretrieving accesspoint informationpoints withintheyourGATEorganization's device management system. This endpoint allows you to query access points with filtering capabilities andpaginationpaginatedcapabilities,results, making it essential fornetworkbuildinginfrastructuredashboards,managementmonitoring systems, andmonitoringlocation-based device management 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 wirelessphysical or logical access points and network infrastructure devices within your organization's GATEinfrastructure. system.Access points represent locations, entry points, or network nodes where devices can connect or be monitored. This API categoryis enablesparticularly developersuseful tofor:
Key Features:
Common Use Cases:
The endpoints work together to provide a complete view of your access point data
The API follows RESTful principles and returns data in JSON format, making it easyyou to integratebuild with modern weblocation-aware applications and monitoringmaintain tools.accurate All responses include pagination metadata to help you efficiently handle large datasetsrecords of your physical and digital access points.
Endpoints
GET /device_app_access_points/
Description: Retrieves a paginated list of all access points fromin theyour GATE system.organization. This endpoint allowsis youthe primary way to fetch comprehensive information about wireless access points,point including their current status, configuration details,data and metadata.supports You can filter resultsfiltering by last modification datedate, making it ideal for synchronization processes and controlbuilding paginationreal-time through limit and offset parameters.dashboards.
Use Cases:
- Building
networkamonitoringfacilitydashboardsmanagementthatdashboarddisplayshowing all accesspoint status
Full URL Example:
https://gate.zequenze.com/api/v1/device_app_access_points/?limit=2050&offset=0&last_change__gte=2024-01-01T00:00:00Z
Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| last_change__gte | string | query | No | Filter results to only include access points modified on or after this date/time (ISO 8601 format) |
| limit | integer | query | No | Number of results to return per page (default |
| offset | integer | query | No | The initial index from which to return results (used for pagination) |
cURL Example:
curl -X GET "https://gate.zequenze.com/api/v1/device_app_access_points/?limit=1025&offset=0&last_change__gte=2024-01-15T00:00:00Z" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Example Response:
{
"count": 145,156,
"next": "https://gate.zequenze.com/api/v1/device_app_access_points/?limit=1025&offset=10"25",
"previous": null,
"results": [
{
"id": 1,
"name": "AP-Floor1-East"Main Building Lobby WiFi",
"mac_address"short_name": "AA:BB:CC:DD:EE:FF"main-lobby-wifi",
"ip_address"is_active": true,
"description": "192.168.1.101"Primary WiFi access point for main building lobby area with high-speed internet access",
"status"organization_id": "online"org_12345",
"location"thumbnail": "Building A - Floor 1 East Wing"https://gate.zequenze.com/media/thumbnails/access_point_1.jpg",
"model"address": "Cisco123 AIR-AP2802I-E-K9"Business Park Drive",
"firmware_version"reference": "8.10.185.0"AP-001-LOBBY",
"ssid_count": 3,
"connected_clients": 24,
"uptime"city": "15dSan 4h 32m"Francisco",
"last_seen"postal_code": "94105",
"state": "California",
"region": "West Coast",
"country_code": "US",
"latitude": "37.7749",
"longitude": "-122.4194",
"created": "2024-01-15T14:10T08: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": "2024-01-01T08:00:00Z",
"updated_at": "2024-01-15T10:15:20T14:45:00Z"
},
{
"id": 2,
"name": "AP-Lobby-Main"Conference Room Alpha Access Point",
"mac_address"short_name": "11:22:33:44:55:66"conf-alpha-ap",
"ip_address"is_active": true,
"description": "192.168.1.102"Dedicated access point for Conference Room Alpha supporting up to 50 concurrent devices",
"status"organization_id": "offline"org_12345",
"location"thumbnail": "Building A - Main Lobby"https://gate.zequenze.com/media/thumbnails/access_point_2.jpg",
"model"address": "Cisco123 AIR-AP2802I-E-K9"Business Park Drive",
"firmware_version"reference": "8.10.185.0"AP-002-CONF-A",
"ssid_count": 2,
"connected_clients": 0,
"uptime"city": "0dSan 0h 0m"Francisco",
"last_seen"postal_code": "94105",
"state": "California",
"region": "West Coast",
"country_code": "US",
"latitude": "37.7749",
"longitude": "-122.4194",
"created": "2024-01-14T16:45:12T10:15:00Z",
"last_change": "2024-01-14T16:45:00Z",
"organization": "Main Office",
"zone": "Guest Network",
"signal_strength": null,
"channel": 11,
"bandwidth": "40MHz",
"power_consumption": 0,
"temperature": null,
"created_at": "2024-01-01T08:00:00Z",
"updated_at": "2024-01-14T16:45:18T16:20:00Z"
}
]
}
Response Codes:
| Status | Description |
|---|---|
| 200 | Success - Returns |
| 401 | Unauthorized - Invalid or missing |
| 403 | Forbidden - Insufficient permissions to access access points |
Common Use Cases
Use Case 1: NetworkBuilding Healtha MonitoringReal-time Access Point Dashboard
CreateFetch all active access points and display their status, location, and connection information on a real-timemonitoring dashboard showing the status of all access points.dashboard. Use the endpointis_active without filtersfield to getfilter alland accesshighlight points,operational then periodically refresh with last_change__gte set to the last update time to fetch only changed devices.status.
Use Case 2: InfrastructureSynchronizing ChangeAccess TrackingPoint Data
Monitor changes to your network infrastructure by callingUse the endpoint with last_change__gte parameter set to trackimplement modificationsincremental synchronization with external facility management systems, only fetching access points that have been modified since your last check. This is useful for compliance reporting and change management.sync.
Use Case 3: CapacityLocation-Based PlanningDevice and AnalyticsManagement
RetrieveCombine allaccess point geographical data (latitude/longitude) with address information to create location-aware applications that can route technicians to specific access points toor analyzegenerate clientservice distribution,reports identifyby high-traffic areas, and plan network capacity upgrades based on connected client counts and signal strength data.region.
Use Case 4: AutomatedInventory Alertingand SystemAsset Tracking
ImplementUtilize monitoringthe thatreference periodicallycodes fetchesand descriptions to maintain accurate inventory records of network infrastructure, tracking access point datadeployment toacross identifymultiple offlinefacilities devices,and overheating units, or access points with unusually low client counts that might indicate connectivity issues.locations.
Use Case 5: Third-PartyReporting Systemand IntegrationAnalytics
SynchronizeGenerate comprehensive reports on access point inventorydistribution using the city, state, and statusregion fields, helping with externalcapacity networkplanning managementand systems,infrastructure CMDBinvestment tools, or asset management platforms using pagination to handle large numbers of devices efficiently.decisions.
Best Practices
-
Pagination
StrategyManagement:UseAlwaysappropriateimplementproperlimitvaluespagination when dealing with large numbers of access points. Start with reasonable page sizes (20-100)25-100to balance performanceitems) andmemoryimplementusage. Always handleclient-side paginationby following thenextURL in responses for large datasets.controls. -
EfficientIncrementalFilteringSynchronization: Use thelast_change__gteparameter forincremental updates rather than fetching allefficient datarepeatedly.synchronization. Store the timestamp of your last successfulrequestsync and use it to fetch only modified records.
Geographic Data Handling: When working with latitude and longitude coordinates, ensure your application properly handles decimal precision and validates coordinate ranges before using them in mapping applications.
Reference Code Standardization: Establish consistent naming conventions for subsequentthe calls.short_name and reference fields to enable better searching, sorting, and integration with other systems.
Error Handling: Implement robust error handling for network timeouts and API rate limits. Consider implementing exponential backoff for retry logic forwhen 5xx errorsdealing with exponentialtemporary backoff.service For 401/403 errors, refresh your authentication token. Handle 422 errors by validating your query parameters.unavailability.
RateCaching Limiting: Implement appropriate delays between requests to avoid overwhelming the API. Monitor response headers for any rate limiting information.
Data CachingStrategy: Cache access point data locallyappropriately andsince usethis information typically doesn't change frequently. Use the filteringlast_change parameterstimestamps to update only changed records, reducing API calls and improving application performance.
Security: Always use HTTPS for API calls, securely store your Bearer tokens, and implement properintelligent tokencache rotation policies. Never log or expose API tokens in client-side code.invalidation.