Device App Access Devices

The Device App Access Devices API provides endpoints for retrieving and managing access point devices within the GATE system. This API allows developers to AccessPoint data and devicequery access control information.devices, Thisfilter endpointby allowsmodification you to retrievedates, and managepaginate through large device accessinventories permissions,for monitorintegration accesswith pointsecurity status,management and track changes to device access configurations across your organization's network infrastructure.systems.

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 Devices API category is designed for managing andaccess monitoringcontrol infrastructure within organizations. This API provides access to access point devices andthat theircontrol associatedphysical entry to buildings, rooms, or secure areas. Each device represents a physical access permissionscontrol withinpoint yourwith networkcomprehensive infrastructure.location Thisdata, APIorganizational iscontext, particularlyand usefuloperational for:status.

Key Concepts:

• Access PointDevices: Management:Physical Retrieve information about access points, their current status, and configuration details

Device Access Control: Monitor whichhardware devices have(card accessreaders, permissionsbiometric throughscanners, specifickeypads) accessthat control entry points ChangeOrganization TrackingContext:: TrackAll modificationsdevices toare deviceassociated with specific organizations for multi-tenant access configurations using timestamp-based filteringcontrol NetworkLocation SecurityData:: MaintainComprehensive visibilityaddressing and controlGPS overcoordinates for precise device mapping Activity Tracking: Last change timestamps enable synchronization and audit capabilities

Common Integration Scenarios:

Synchronizing access control systems with facility management platforms Building security dashboards and monitoring applications Integrating with visitor management and employee onboarding systems Creating location-based security reports and analytics Managing device inventories across yourmultiple organization's networkfacilities

The primaryAPI endpointuses instandard thispagination categorypatterns and supports paginationfiltering andby changemodification tracking,dates, making it suitableideal for bothincremental synchronization workflows and real-time monitoring and bulk data synchronization scenarios. The last_change__gte parameter enables efficient incremental updates by allowing you to fetch only devices that have been modified since a specific timestamp.applications.

---

Endpoints

GET /device_app_access_devices/

Description: Retrieves a paginated list of device access pointscontrol devices with comprehensive location and theirorganizational associated access permissions.data. This endpoint providesis comprehensiveessential informationfor aboutbuilding device inventories, synchronizing access pointcontrol devices, including their current status, configuration details,systems, and recentcreating changes.facility It'smanagement theintegrations. primaryThe methodresponse includes detailed addressing information, GPS coordinates, and device metadata suitable for monitoringmapping deviceand accessreporting across your network infrastructure.applications.

Use Cases:

• MonitorBuilding allcomprehensive device inventories for security audits

Synchronizing access control data with facility management systems Creating interactive maps of access points across multiple locations Generating compliance reports showing device locations and their current operational status SynchronizeImplementing devicereal-time accessmonitoring datadashboards withfor externalsecurity systems Track changes to access permissions over time Generate reports on device access patterns and usageoperations

Full URL Example:

https://gate.zequenze.com/api/v1/device_app_access_devices/?last_change__gte=2024-01-15T10:00:00Z&limit=50&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 devices modified on or after this timestamp (ISO 8601 format). Useful for incremental synchronization.synchronization
limit	integer	query	No	Number of results to return per page.page Default(default: issystem configured, typically 20, maximum recommended is 100 for optimal performance.20-100)
offset	integer	query	No	The initialStarting index fromfor whichpagination. toUse returnwith the results. Usedlimit for paginationtraversing -large multiplydevice page number by limit to get offset.inventories

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/device_app_access_devices/?limit=25&last_change__gte=2024-01-15T10:01T00:00:00Z&limit=25&offset=0"00Z" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 157,147,
  "next": "https://gate.zequenze.com/api/v1/device_app_access_devices/?limit=25&offset=25&last_change__gte=2024-01-15T10%3A00%3A00Z"25",
  "previous": null,
  "results": [
    {
      "id": 1247,
      "device_id": "ap-lobby-001",1001,
      "name": "Main LobbyEntrance AccessCard Point"Reader",
      "mac_address"short_name": "00:1B:44:11:3A:B7"main-entrance-cr",
      "ip_address"is_active": true,
      "description": "192.168.1.101"Primary access control point for building main entrance with integrated camera system",
      "location"organization_id": "org_12345678",
      "thumbnail": "https://gate.zequenze.com/media/devices/thumbnails/reader_001.jpg",
      "address": "123 Corporate Blvd",
      "reference": "Building A - MainLevel Lobby"1",
      "status"city": "active"San Francisco",
      "access_level"postal_code": "employee"94105",
      "allowed_devices": [
        {
          "device_mac"state": "AA:BB:CC:DD:EE:FF"California",
      "device_name"region": "John'sBay Laptop"Area",
      "access_granted"country_code": true,"US",
      "last_access"latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T14:23:12Z"
        },
        {
          "device_mac": "11:22:33:44:55:66"15T08:30:00Z",
      "device_name": "Conference Room Tablet",
          "access_granted": true,
          "last_access"last_change": "2024-01-15T13:45:30Z"
        }
      ],
      "organization_id": 42,
      "created_at": "2024-01-10T09:15:00Z",
      "last_modified": "2024-01-15T11:30:45Z",
      "is_online": true,
      "signal_strength": -45,
      "firmware_version": "2.4.1"20T14:22:15Z"
    },
    {
      "id": 1248,
      "device_id": "ap-conference-002",1002,
      "name": "ConferenceExecutive RoomFloor BBiometric Access Point"Scanner",
      "mac_address"short_name": "00:1B:44:22:4B:C8"exec-bio-scanner",
      "ip_address"is_active": true,
      "description": "192.168.1.102"High-security biometric access control for executive floor with dual authentication",
      "location"organization_id": "org_12345678",
      "thumbnail": "https://gate.zequenze.com/media/devices/thumbnails/bio_scanner_002.jpg",
      "address": "123 Corporate Blvd",
      "reference": "Building A - ConferenceLevel Room B"15",
      "status"city": "active"San Francisco",
      "access_level"postal_code": "guest"94105",
      "allowed_devices": [
        {
          "device_mac"state": "77:88:99:AA:BB:CC"California",
      "device_name"region": "VisitorBay Mobile"Area",
      "access_granted"country_code": true,"US",
      "last_access"latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T10:10T12:15:22Z"
        }
      ]00Z",
      "organization_id": 42,
      "created_at"last_change": "2024-01-12T14:20:00Z",
      "last_modified": "2024-01-15T10:15:22Z",
      "is_online": true,
      "signal_strength": -38,
      "firmware_version": "2.4.1"18T09:45:30Z"
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns the paginated list of device access pointsdevices with full metadata
401	Unauthorized - Invalid or missing Bearer token
403	Forbidden - InsufficientToken permissionslacks permission to access device data
404400	NotBad FoundRequest - Invalid endpointquery orparameters organization(e.g., notmalformed found

date 429 Too Many Requests - Rate limit exceeded 500 Internal Server Error - Server-side error occurredformat)

---

Common Use Cases

Use Case 1: Real-time AccessDevice PointInventory MonitoringSynchronization

MonitorIntegrate thewith statusfacility ofmanagement all access points in your networksystems by polling thisfor endpointdevice regularly.changes Useusing the last_change__gte parameterparameter. toThis fetchenables onlyreal-time recentlysynchronization updatedof devices,access reducingcontrol bandwidthinfrastructure with building management platforms, ensuring accurate device status and processinglocation timedata whileacross maintainingall up-to-date information about device connectivity and access permissions.systems.

Use Case 2: Incremental Data Synchronization

Synchronize device access data with external security systems or databases by using timestamp-based filtering. Store the timestamp of your last successful sync and use it with last_change__gte to fetch only modified records in subsequent requests.

Use Case 3: Access Audit andSecurity Compliance Reporting

Generate comprehensive reports on device access patterns by retrievingshowing all access pointscontrol devices across multiple facilities, including their physical locations, operational status, and theirorganizational associatedassignments. deviceThe permissions.detailed addressing and GPS data supports regulatory compliance requirements and security audits.

Use paginationCase to3: handleInteractive largeFacility datasetsSecurity efficientlyMaps

while

Build buildinginteractive auditdashboards trailsshowing access point locations using the latitude/longitude coordinates and address information. The thumbnail images and detailed descriptions provide rich context for compliancesecurity requirements.personnel monitoring facility access points.

Use Case 4: NetworkDevice SecurityMaintenance DashboardScheduling

BuildTrack adevice securitymetadata dashboardand showinglast real-timechange timestamps to implement predictive maintenance workflows. The comprehensive device information supports maintenance scheduling, warranty tracking, and replacement planning for access pointcontrol status, connected devices, and recent access events. Combine this endpoint with appropriate filtering and pagination to create responsive, up-to-date visualizations of your network security posture.infrastructure.

Use Case 5: AutomatedMulti-tenant Access Management

ImplementUtilize automatedorganization_id workflowsfiltering that(when respondavailable) to changesmanage access control devices across multiple tenants or business units, ensuring proper isolation and access control in deviceenterprise access permissions by monitoring the last_modified timestamps and processing newly connected or disconnected devices for policy enforcement or alerting.environments.

---

Best Practices

• ImplementPagination PaginationStrategy:: AlwaysUse useappropriate thelimit limitvalues parameter to control response size. Start with (25-50 items per page and adjust100) based on your application's performancememory requirements.constraints and network conditions. Implement cursor-based pagination using the provided next/previous URLs for consistent results.

• Use Incremental UpdatesSynchronization:: Leverage the last_change__gte parameter for efficient data synchronization. Store the last sync timestamp ofand youronly retrieve devices modified since the last successful request and use itsync to fetch only modified records.

Handle Rate Limits: Implement exponential backoff retry logic to handle 429 responses gracefully. Avoid making excessive concurrent requests to prevent hitting API rate limits.

Monitor Response Times: Large result sets can impact performance. If responses are slow, reduce your page size or implement more specific filtering criteria.

Cache Appropriately: Access point data doesn't change frequently, so implement reasonable caching strategies (5-15 minutes) to reduceminimize API calls while maintainingand data freshness.transfer.

Error HandlingHandling:: Implement robust retry logic for temporary failures, and cache device data locally to handle API unavailability. Always checkvalidate the response statusstructure codesbefore processing device data in your application.

Rate Limiting: Monitor API response headers for rate limiting information and implement properexponential errorbackoff handlingstrategies. Consider implementing local caching to reduce API calls for networkfrequently timeouts,accessed authenticationdevice failures, and server errors.data.

Security ConsiderationsConsiderations:: StoreDevice location and organizational data is sensitive - ensure secure storage of API responses and implement appropriate access controls in your application. Never log or expose API tokens securelyin client-side code or logs.

Data Validation: Always validate GPS coordinates are within expected ranges and useaddress HTTPSdata foris properly formatted before using in mapping or reporting applications. Handle optional fields gracefully as not all requests.devices Considermay implementinghave tokencomplete rotationlocation and never log sensitive device information.data.

---