External HTTP APIs
VWire publishes two HTTP integration styles for external systems.
| API style | Authentication | Best for |
|---|---|---|
| Simple API | Device token in the URL query string | Device firmware, quick scripts, lightweight tooling |
| RESTful API | X-API-Key header | Backend services, automation workers, production integrations |
Plan requirement
External API access requires a Pro plan or higher. The Free plan does not include API access.
Choose the right API
Use the Simple API when you need the smallest possible request shape and your environment makes custom headers difficult.
Use the RESTful API when you are building a server-side or production integration and want header-based authentication, structured responses, and resource-oriented routes.
References
- Simple API for token-based device calls.
- RESTful API for header-authenticated external integrations.
Shared notes
- Both HTTP API styles are rate-limited by plan.
- All timestamps are returned in ISO 8601 UTC format.
- Pin values are transported as strings.
- Dashboard-internal application APIs are not part of this public documentation set.