API Reference¶
Complete API documentation for integrating with the RTK Base.
Available Interfaces¶
REST API¶
HTTP-based API for configuration and monitoring:
- System information retrieval
- Configuration management
- System control commands
- Firmware updates
MQTT API¶
Real-time messaging for cloud connectivity:
- RTCM data streaming
- Remote command execution
- Status reporting
- Production testing
Quick Comparison¶
| Feature | REST API | MQTT API |
|---|---|---|
| Protocol | HTTP | MQTT over TLS |
| Port | 80 | 8883 |
| Best for | Configuration | Real-time data |
| Authentication | None (local) | TLS certificates |
| Latency | Request/response | Publish/subscribe |
| Use case | Web interface | Cloud integration |
Integration Examples¶
Web Application¶
Use REST API for:
- Configuration UI
- Status dashboards
- Diagnostic tools
Cloud Service¶
Use MQTT API for:
- Fleet management
- Remote monitoring
- Data analytics
- OTA updates
Robotics¶
Use both:
- MQTT for RTCM corrections
- REST for configuration
Getting Help¶
- Review specific API documentation
- Check Console Commands for debugging
- See Architecture for system details