Device App Register
The Device App Register API enables mobile and desktop applications to register themselves with the backend
system.system,Thisprovidingendpointcomprehensiveis typically used during app initialization or onboarding processes to establish a connection between client applicationsdevice andtheuserserverinformationinfrastructure.for tracking, analytics, and user management purposes.
Base URL: https://gate.zequenze.com/api/v1
Authentication: All endpoints require a Bearer token:
Authorization: Bearer <your-api-token>
Overview
The Device App Register API categoryis provides functionalitydesigned for applications to register themselves and their associated device information with the backend system.system during the initial setup or authentication process. This isregistration acaptures crucialcritical stepdevice inmetadata, network information, user credentials, and application details that enable the application lifecycle that establishes the connection between client applications (mobile apps, desktop software, IoT devices, etc.) and the server infrastructure.
When an application starts up for the first time or needs to re-establish its connection with the backend, it uses this registration endpointsystem to:
AuthenticatetheDeviceapplicationTracking & Analytics: Collect comprehensive device fingerprints including IMEI, IMSI, MAC addresses, and device specifications for security and analytics purposes
This registration processAPI is essentialtypically forcalled applicationsonce thatper needapplication installation or when significant device/user changes occur. The comprehensive data collection enables backend systems to maintainprovide persistentpersonalized connectionsexperiences, orsecurity receive push notifications, updates, or other server-initiated communications. The registration data helps administrators monitor connected applicationsmonitoring, and managetargeted device policies across their infrastructure.communications.
Endpoints
POST /device_app_register/
Description: Registers a new application instanceinstallation with the backend system.system, capturing comprehensive device metadata, network information, and user credentials. This endpoint acceptsis applicationessential metadatafor establishing device identity, enabling push notifications, and devicelinking informationapplications to establishuser a registered session between the client application and the server. Use this endpoint when your application starts up for the first time, after a fresh installation, or when re-establishing connection after extended offline periods.accounts.
Use Cases:
- Initial app
registrationinstallationduring first-timeand setup process Re-registrationUserafterauthenticationappandreinstallationaccountor major updateslinkingEstablishingDeviceconnectionfingerprinting forIoTsecuritydevices joining the networkpurposesRegisteringPushapplicationsnotificationthatserviceneedregistration
Full URL Example:
https://gate.zequenze.com/api/v1/device_app_register/
Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| data | string | body | Yes | JSON string containing |
Request Body Structure:
The data parameter should contain a JSON object with the following optional fields:
cURL Example:
curl -X POST "https://gate.zequenze.com/api/v1/device_app_register/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"app_name"number": "MyMobileApp"+1234567890",
"generic_id": "550e8400-e29b-41d4-a716-446655440000",
"imei": "123456789012345",
"device_brand": "Apple",
"device_model": "iPhone 15 Pro",
"device_type": "ph",
"os_family": "iOS",
"os_version": "17.2.1",
"app_version": "2.1.0",
"platform"username": "iOS"john.doe",
"device_id"push_key": "ABC123-DEF456-GHI789"abc123def456ghi789",
"device_model"home_mobile_network_name": "iPhone 14 Pro"Verizon",
"os_version"home_mobile_network_mccmnc": "16.4.1",
"push_token": "fcm_token_abc123def456",
"installation_id": "unique-install-uuid-here"31000"
}'
Example Response:
{
"registration_id"number": "reg_12345abcdef"+1234567890",
"status"generic_id": "registered"550e8400-e29b-41d4-a716-446655440000",
"app_config"imei": {
"api_refresh_interval": 300,
"push_enabled": true,
"feature_flags": {
"new_dashboard": true,
"beta_features": false
}
}123456789012345",
"device_token"imsi": "device_token_xyz789"310000123456789",
"registration_timestamp"iccid": "2024-01-15T10:30:00Z"8901260123456789012",
"expires_at"mac_addr": "2024-07-15T10:30:00Z"02:00:00:00:00:00",
"home_mobile_network_name": "Verizon",
"home_mobile_network_mccmnc": "31000",
"app_version": "2.1.0",
"os_family": "iOS",
"os_version": "17.2.1",
"os_api_version": "17.2",
"device_family": "iPhone",
"device_brand": "Apple",
"device_model": "iPhone 15 Pro",
"device_type": "ph",
"push_key": "abc123def456ghi789",
"username": "john.doe",
"user_external_id": "ext_user_12345",
"user_class": "premium"
}
Response Codes:
| Status | Description |
|---|---|
| 201 | Created - |
| 400 | Bad Request - Invalid |
| 401 | Unauthorized - Invalid or missing authentication token |
| 409 | Conflict - |
Common Use Cases
Use Case 1: Mobile App First Launch
WhenRegister a user installs and opens yournew mobile application forinstallation during the user's first time,launch, callcapturing thisdevice endpointidentifiers, tonetwork register the app instance. Include the device's unique identifier, push notification token,information, and appbasic versionuser tocredentials enablefor fullaccount functionality.creation or login.
Use Case 2: IoTCross-Platform DeviceUser OnboardingMigration
ForRegister IoTa devicesnew joiningdevice yourwhen network,an useexisting thisuser endpoint duringinstalls the initialapplication setupon processan additional device, linking the new device to registertheir theexisting account while maintaining separate device with your backend system. This enables remote monitoring, configuration updates, and command delivery.profiles.
Use Case 3: ApplicationEnterprise Re-authenticationDevice Management
AfterRegister majorcorporate appdevices updateswith orcomprehensive when authentication tokens expire, re-register the application to refresh credentialshardware and receivenetwork updatedinformation configurationfor settings.compliance tracking, security monitoring, and asset management in enterprise environments.
Use Case 4: Multi-DevicePush UserNotification AccountsEnablement
When users install your app on multiple devices, register eachRegister device separatelypush notification tokens along with device metadata to enable device-specifictargeted, personalized notifications based on device type, location, and trackuser preferences.
Use Case 5: Analytics and Telemetry Setup
Establish device fingerprints and user associations for analytics tracking, enabling detailed usage analysis, performance monitoring, and user behavior insights across different platforms.device types and network conditions.
Best Practices
-
IncludeGradualUniqueDataIdentifiersCollection::AlwaysOnlyprovide stable, uniquecollect deviceidentifiersinformation thatpersistyouracrossapplicationappactuallyrestartsneeds.butStartchangewith essential fields and expand based onreinstallationspecificforuseprivacy compliancecases -
HandlePrivacyRegistrationCompliance:Expiry:EnsureMonitorusertheconsentexpires_atfieldcollectinginsensitiveresponsesidentifiers like IMEI, IMSI, or location-related network data, following GDPR, CCPA, andre-registerotherbeforeprivacyexpiration to maintain uninterrupted service