API Integration Handbook
Complete guide to integrating with our RESTful APIs for automated device management
Why API Integration?
While our web portal provides powerful manual device management capabilities, true scalability comes from API integration. Connecting your existing systems—loan management platforms, CRM, payment processors, or core banking systems—enables fully automated workflows that eliminate manual tasks and reduce errors.
Our RESTful API provides programmatic access to all device management functions: enrollment, policy application, device locking/unlocking, status monitoring, and analytics retrieval. You can build custom integrations that fit your exact business processes.
Core API Capabilities
Device Management
- • Enroll new devices programmatically
- • Update device configurations
- • Query device status and health
- • Send remote commands
- • Unenroll and wipe devices
Lock/Unlock Control
- • Lock devices on payment default
- • Unlock upon payment confirmation
- • Set custom lock messages
- • Schedule lock/unlock operations
- • Query lock status
Analytics & Reporting
- • Retrieve device analytics
- • Export compliance reports
- • Monitor fleet health metrics
- • Track policy compliance
- • Generate custom reports
Webhooks & Events
- • Real-time event notifications
- • Device status change alerts
- • Payment compliance events
- • Security incident reporting
- • Custom webhook endpoints
Getting Started with the API
Authentication
Our API uses API key authentication. Generate your API key from the dashboard settings. Include it in the Authorization header of all requests:
Base URL
Example: Lock a Device
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
{
"reason": "Payment overdue",
"message": "Please make payment to unlock",
"allow_emergency_calls": true
}
Common Integration Patterns
Automated Lock/Unlock on Payment
When your payment processor confirms payment, trigger an API call to unlock the device. When payment fails after grace period, automatically lock the device. This creates a real-time connection between payment status and device access.
Customer Onboarding Automation
When a new customer signs up for device financing, automatically generate a QR code and send it via SMS. Track when they enroll their device and trigger the next steps in your onboarding workflow.
Custom Dashboards & Analytics
Pull device data into your internal BI tools for custom reporting. Track payment compliance rates, device health metrics, and operational KPIs alongside your other business data.
Proactive Monitoring Alerts
Use webhooks to receive real-time alerts when devices go offline, batteries run critically low, or security policies are violated. Proactively address issues before they impact operations.
API Integration Best Practices
- Rate Limiting: Respect API rate limits (typically 1000 requests/hour)
- Error Handling: Implement retry logic with exponential backoff
- Idempotency: Use idempotency keys for critical operations like lock/unlock
- Webhooks: Validate webhook signatures to ensure authenticity
- Testing: Use sandbox environment for development and testing
Ready to Build Your Integration?
Get API access and start automating your device management workflows today