Skip to main content

Hostspot Access Points

The Hotspot Access Points API provides endpoints for managing and retrieving network access point locations within your organization. This API allows you to query access point data with location coordinates, filter by activity status, and retrieve detailed information about each hotspot location including address details and geographical coordinates.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Hotspot Access Points API is designed for managing wireless network infrastructure locations within your organization. This API enables network administrators and developers to programmatically access information about Wi-Fi hotspots, access points, and their physical locations.

Key Features:

  • Retrieve comprehensive access point location data
  • Filter by geographical coordinates availability
  • Query by last modification timestamps
  • Paginated results for large datasets
  • Support for location-based services integration

Common Integration Scenarios:

  • Network monitoring dashboards that display access point locations on maps
  • Mobile applications that help technicians locate specific hotspots for maintenance
  • Analytics platforms tracking network coverage across different regions
  • Inventory management systems maintaining records of deployed network equipment
  • Geofencing applications that trigger actions based on proximity to access points

The API follows REST conventions with standardized response formats, making it easy to integrate with existing network management tools and custom applications.

Endpoints

GET /hostspot_access_points/

Description: Retrieves a paginated list of all hotspot access points in your organization. This endpoint provides comprehensive information about each access point including location details, status, and geographical coordinates. It's the primary endpoint for accessing your network infrastructure data and supports various filtering options to help you find specific access points or those meeting certain criteria.

Use Cases:

  • Display all active access points on a network monitoring dashboard
  • Generate reports of network coverage across different geographical regions
  • Identify access points that need coordinate updates for mapping applications
  • Audit network infrastructure changes within a specific time period
  • Export access point data for integration with third-party network management tools

Full URL Example:

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=25&offset=0

Parameters:

Parameter Type In Required Description
last_change__gte string query No Filter results to only include access points modified on or after the specified date/time. Accepts ISO format dates: 2000-01-01, 2000-01-01 00:01:00, or 2000-01-01 00:01:00+00:00
limit integer query No Number of results to return per page. Use for pagination control. Default and maximum limits are set by the server
offset integer query No The starting index for results. Use with limit for pagination (e.g., offset=25&limit=25 for page 2)
have_coordinates boolean query No When set to true, only returns access points that have both latitude and longitude coordinates configured

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=10" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 156,
  "next": "https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=10&offset=10",
  "previous": null,
  "results": [
    {
      "id": 1001,
      "name": "Main Building - Ground Floor AP",
      "short_name": "main-building-ground-ap",
      "is_active": true,
      "description": "Primary access point covering lobby and reception area",
      "organization_id": "org_abc123def456",
      "thumbnail": "https://gate.zequenze.com/media/thumbnails/ap_1001_thumb.jpg",
      "address": "123 Business Park Drive",
      "reference": "Building A - Suite 100",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "West Coast",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T08:30:00Z",
      "last_change": "2024-03-10T14:22:15Z"
    },
    {
      "id": 1002,
      "name": "Conference Room WiFi Hub",
      "short_name": "conference-room-hub",
      "is_active": true,
      "description": "High-capacity access point for conference and meeting rooms",
      "organization_id": "org_abc123def456",
      "thumbnail": "https://gate.zequenze.com/media/thumbnails/ap_1002_thumb.jpg",
      "address": "123 Business Park Drive",
      "reference": "Building A - 2nd Floor Conference Wing",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "West Coast",
      "country_code": "US",
      "latitude": "37.7751",
      "longitude": "-122.4192",
      "created": "2024-01-20T10:15:30Z",
      "last_change": "2024-02-28T09:45:22Z"
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns paginated list of access points
401 Unauthorized - Invalid or missing Bearer token
403 Forbidden - Token valid but lacks permission for this resource
422 Unprocessable Entity - Invalid query parameter format (e.g., malformed date)
500 Internal Server Error - Server-side error occurred

Common Use Cases

Use Case 1: Network Coverage Mapping

Retrieve all access points with coordinates to display network coverage on an interactive map. Use have_coordinates=true to ensure you only get mappable locations, then plot each access point using the latitude and longitude fields.

Use Case 2: Infrastructure Audit and Maintenance

Query access points modified within a specific timeframe using last_change__gte to identify recently updated configurations. This helps track maintenance activities and ensure network changes are properly documented.

Use Case 3: Mobile Technician App

Build a mobile application that helps field technicians locate specific access points for maintenance or troubleshooting. Use the address, reference, and coordinate data to provide turn-by-turn navigation to equipment locations.

Use Case 4: Network Inventory Management

Export complete access point data for integration with asset management systems. Use pagination with appropriate limit/offset values to process large datasets efficiently without overwhelming system resources.

Use Case 5: Regional Performance Analytics

Filter access points by geographical regions using the city, state, and region fields to generate location-based network performance reports and identify areas needing infrastructure improvements.

Best Practices

  • Pagination Strategy: Always use reasonable limit values (10-100) to avoid timeout issues with large datasets. Implement proper pagination logic using the next and previous URLs provided in responses.

  • Coordinate Filtering: When building mapping applications, always use have_coordinates=true to avoid attempting to plot access points without location data, which would cause map rendering errors.

  • Date Filtering: Use ISO 8601 format dates for last_change__gte parameter. Include timezone information when precision is important: 2024-03-01T00:00:00+00:00.

  • Caching Considerations: Access point data typically changes infrequently, making it suitable for caching. Consider implementing cache invalidation based on the last_change timestamp.

  • Error Handling: Always handle pagination edge cases (empty results, last page) and validate coordinate data before using it in mapping applications. Some access points may have partial address information.

  • Security: Never expose Bearer tokens in client-side code. Use server-side proxies or secure token refresh mechanisms for web applications accessing this API.

Back to top