Skip to main content

Device App User Authenticate

The device_app_user_authenticate endpoint provides secure user credential validation for device applications within the GATE API system. This authentication mechanism is specifically designed for mobile and IoT devices that need to verify user credentials before granting access to protected resources and functionality.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The device_app_user_authenticate API category is designed to handle user authentication specifically for device-based applications such as mobile apps, IoT devices, and embedded systems. This endpoint serves as a secure gateway for validating user credentials before allowing access to device-specific features and protected resources.

Key Features:

  • Secure credential validation for device applications
  • Token-based authentication flow
  • Designed for mobile and IoT device integration
  • Returns validated user information upon successful authentication

Common Integration Scenarios:

  • Mobile application login flows
  • IoT device user verification
  • Embedded system access control
  • Device-to-server authentication workflows

This authentication system is particularly useful when you need to verify user credentials from devices that may have limited connectivity or processing power, providing a streamlined authentication process optimized for device applications.

Endpoints

POST /device_app_user_authenticate/

Description: Validates user credentials provided by device applications and returns authentication status along with user information. This endpoint is specifically designed for mobile apps, IoT devices, and other client applications that need to authenticate users before accessing protected resources.

Use Cases:

  • Mobile app user login verification
  • IoT device user authentication before device pairing
  • Embedded system access control validation
  • Device application session initiation

Full URL Example:

https://gate.zequenze.com/api/v1/device_app_user_authenticate/

Parameters:

Parameter Type In Required Description
data string body Yes JSON string containing user credentials (username and password)

Request Body Structure: The data parameter should contain a JSON object with the following structure:

{
  "username": "user@example.com",
  "password": "securePassword123"
}

cURL Example:

curl -X POST "https://gate.zequenze.com/api/v1/device_app_user_authenticate/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": "{\"username\":\"user@example.com\",\"password\":\"securePassword123\"}"
  }'

Example Response (Success):

{
  "username": "user@example.com",
  "password": "securePassword123",
  "authenticated": true,
  "user_id": 12345,
  "device_permissions": [
    "device_control",
    "data_access",
    "settings_modify"
  ],
  "session_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2024-01-15T18:30:00Z"
}

Example Response (Authentication Failed):

{
  "authenticated": false,
  "error": "Invalid credentials",
  "error_code": "AUTH_FAILED",
  "message": "The provided username or password is incorrect"
}

Response Codes:

Status Description
201 Success - User authenticated successfully
400 Bad Request - Invalid data format or missing required fields
401 Unauthorized - Invalid API token
403 Forbidden - User account is disabled or restricted
429 Too Many Requests - Rate limit exceeded for authentication attempts
500 Internal Server Error - Authentication service unavailable

Common Use Cases

Use Case 1: Mobile App Login Flow

Integrate user authentication into your mobile application by sending user credentials to validate login attempts. The endpoint returns user information and permissions that can be used to customize the app experience based on the authenticated user's access level.

Use Case 2: IoT Device User Pairing

Before allowing a user to pair with or control an IoT device, validate their credentials to ensure they have the necessary permissions. This is particularly useful for smart home devices, industrial sensors, or any connected device requiring user-specific access control.

Use Case 3: Embedded System Access Control

Use this endpoint to authenticate users attempting to access embedded systems such as kiosks, industrial control panels, or specialized hardware interfaces. The authentication ensures only authorized users can interact with critical systems.

Use Case 4: Device Application Session Management

Establish authenticated sessions for device applications by validating user credentials and receiving session tokens that can be used for subsequent API calls, maintaining secure communication throughout the user session.

Best Practices

  • Secure Credential Handling: Always transmit credentials over HTTPS and avoid storing passwords in plain text on client devices. Consider implementing credential caching with proper encryption for offline scenarios.

  • Rate Limiting Awareness: Implement exponential backoff for failed authentication attempts to respect rate limits and prevent account lockouts. Consider implementing client-side throttling for repeated authentication failures.

  • Token Management: Store and manage session tokens securely on the device. Implement automatic token refresh mechanisms and handle token expiration gracefully to maintain seamless user experience.

  • Error Handling: Provide clear, user-friendly error messages while avoiding exposing sensitive information. Implement proper error handling for network connectivity issues common in device applications.

  • Offline Considerations: For devices that may operate offline, consider implementing cached authentication with appropriate security measures, ensuring users can still access critical functionality when connectivity is limited.

  • Device-Specific Security: Implement additional security measures appropriate for your device type, such as biometric authentication on mobile devices or hardware-based security for IoT devices, using this endpoint as part of a multi-factor authentication flow.

Back to top