REST / HTTPS
Unified API style for cloud and local gateway; JSON data exchange
Back to Solutions
Developer API platform
Standard device models and REST interfaces for PMS and third-party systems.
The PurePoint Smart developer platform provides standardized RESTful API and open SDK for integrators, PMS/CRS vendors and ISVs — covering device onboarding, room status, scene control, energy data and event subscriptions. Via cloud or local gateway, embed PurePoint guestroom control into your hotel operations and building management systems quickly.
Download SDK & docs · Cloud management platform · Request API keys
Platform capabilities
-
RESTful API
JSON request/response over HTTPS, versioned paths — easy integration for front-end, back-end and third-party systems.
-
Multi-language SDK
Java, Python and Node.js samples plus signing utilities to shorten integration and go-live cycles.
-
Webhook events
Room status changes, alerts and scene results pushed proactively — with retry and signature verification.
-
Sandbox
Dedicated test tenant and simulated devices for pre-production integration and load validation (apply to enable).
API modules
Interfaces grouped by business domain with scoped authorization; field definitions and rate limits follow official documentation.
-
Devices & points
Query RCU, panel and sensor online status; read/write point values, digital and analog I/O.
-
Rooms & status
Sync check-in/out, DND, MUR, SOS and other room states; map to PMS room numbers.
-
Scenes & linkage
Trigger welcome, vacant power-off, meeting mode and other scenes; query results and failure reasons.
-
Energy & reports
Aggregate power and HVAC data by room, floor or public area; export report interfaces.
-
Alerts & ops
Subscribe to device offline, comms fault and load alerts; integrate with ticketing systems.
-
Projects & access
Multi-hotel/project tenant isolation; AppKey, roles and API scope management.
Quick start
-
Register developer account
Submit integration request via sales or support to obtain AppKey / AppSecret.
-
Configure callback URL
Register Webhook URL in the developer console for room status and alert events.
-
Sandbox integration
Call APIs with test project ID to verify signing, auth and business fields.
-
Production go-live
After acceptance, switch to production credentials and monitor call volume and error rates per SLA.
Common endpoints
Typical REST path examples; download full OpenAPI spec from the download center.
| Method | Path | Description |
|---|---|---|
| POST | /v1/oauth/token | Obtain access token (Client Credentials) |
| GET | /v1/projects/{id}/rooms | Paginated room list with status summary |
| GET | /v1/projects/{id}/rooms/{roomNo}/devices | Devices and online status for a room |
| PUT | /v1/projects/{id}/rooms/{roomNo}/scene/{sceneId} | Trigger scene (e.g. welcome, vacant power-off) |
| POST | /v1/projects/{id}/rooms/{roomNo}/points | Batch write points (switches, dimming, HVAC setpoints, etc.) |
| GET | /v1/projects/{id}/energy/summary | Energy summary for a time range |
| POST | /v1/webhooks/subscriptions | Register Webhook subscription (room status, alerts, etc.) |
Protocols & ecosystem
Beyond HTTP API, field buses and third-party platforms are supported for diverse hotel and building integration.
BACnet / Modbus
Protocol conversion for BMS, HVAC, metering and other subsystems
MQTT
Device reporting and command delivery in low-bandwidth scenarios
KNX / ecosystem plugins
Works with KNX, Home Assistant and other interconnect solutions
Onboarding process
Submit request
Describe integration scenario, expected call volume and go-live timeline
Issue credentials
Sandbox and production environment keys assigned
Integration test
Technical support assists with API and Webhook testing
Go live
Switch to production and include in ops monitoring
FAQ
How do I get API keys?
Available to contracted integrators and strategic customers. Submit an integration brief via sales or support; after approval, create an app in the developer console for AppKey and AppSecret.
Is local gateway deployment supported?
Yes. Large hotel groups can use local edge gateways with cloud-consistent API in offline and low-latency scenarios; architecture is defined per project.
Are there rate limits?
Default QPS and daily quotas apply per app; bulk projects can request increases. Exceeding limits returns 429 — implement exponential backoff.
How are Webhooks secured?
Event payloads include HMAC signature and timestamp; verify signature and reject stale requests. Use HTTPS endpoints; IP allowlists available on request.
How does this differ from the cloud platform?
Cloud platform is visual ops for staff; developer API is for system integration and automation — PMS, CRM, energy platforms, etc. Both can be used together.
Need on-site training or after-sales support?
We offer API integration training, project acceptance coaching and full lifecycle technical support.
