Service & Support

Developer APIs · Integrate PMS, apps, and custom UIs

Home Service & Support

Cloud Platform Developer API Downloads Training After-sales

Kanway Developer Platform offers RESTful APIs and SDKs for integrators, PMS/CRS vendors and ISVs — device onboarding, room status, scenes, energy and webhooks via cloud or local gateway.

Download SDK & docs · Cloud Platform · Request API keys

Platform capabilities

  • RESTful API

    JSON request/response over HTTPS with versioned paths for front-end, back-end and third-party integration.

  • Multi-language SDK

    Java / Python / Node.js samples and signing utilities to shorten integration and go-live.

  • Webhook events

    Push room status, alerts and scene results with retry and signature verification.

  • Sandbox

    Isolated test tenant and simulated devices for integration and load tests before production (apply to enable).

API modules

APIs grouped by domain with scoped authorization — fields and rate limits per official documentation.

  • Devices & points

    Query RCU, panel and sensor online status; read/write point values, digital and analog I/O.

    • Device list
    • Point read/write
    • Bulk sync

  • Rooms & status

    Sync check-in/out, DND, make-up room, SOS; map PMS room numbers.

    • Room status sync
    • Room mapping
    • Check-in linkage

  • Scenes & linkage

    Trigger welcome, away power-off, meeting modes; query results and failure reasons.

    • Scene trigger
    • Scheduled tasks
    • Logic query

  • Energy & reports

    Aggregate power and HVAC data by room/floor/public area; export APIs.

    • Energy query
    • Analytics reports
    • Data export

  • Alerts & O&M

    Subscribe to offline, communication and overload alerts; integrate with ticketing.

    • Alert list
    • Webhook
    • Ticket callback

  • Projects & permissions

    Multi-hotel/project tenant isolation; AppKey, roles and API scopes.

    • Tenant admin
    • OAuth2
    • Audit log

Quick start

  1. Register developer account

    Submit integration request via sales or support for AppKey / AppSecret.

  2. Configure callback URL

    Register Webhook URL in the developer console for room status and alerts.

  3. Sandbox integration

    Call APIs with test project ID to verify signing, auth and payloads.

  4. Go live

    Switch to production keys after acceptance; monitor volume and errors per SLA.

Common endpoints

Typical REST paths below — full OpenAPI spec in Downloads.

Method Path Notes
POST /v1/oauth/token Get access token (client credentials)
GET /v1/projects/{id}/rooms Paginated room list and 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 scenes (welcome, away power-off, etc.)
POST /v1/projects/{id}/rooms/{roomNo}/points Batch write points (switches, dimming, HVAC setpoints)
GET /v1/projects/{id}/energy/summary Energy summary by time range
POST /v1/webhooks/subscriptions Register webhook subscriptions (room status, alerts, etc.)

Protocols & ecosystem

Besides HTTP APIs: field buses and third-party platforms for diverse hotel and building integration.

REST / HTTPS

Unified cloud/local gateway API style with JSON payloads

BACnet / Modbus

Protocol conversion for BMS, HVAC, meters and subsystems

MQTT

Low bandwidth scenario device reporting and command issuance

KNX/Ecosystem Plugin

Works with KNX, Home Assistant, and other connectivity solutions

Onboarding

Submit

Describe integration scenarios, estimated calls, and time to go online

Activation Key

Assign sandbox and production credentials

Commissioning & acceptance

Technical support to assist with interface and webhook testing

Go live officially

Switch production environment and include O&M monitoring

FAQs

How to get API Key

Available to signed integrators and strategic customers. Submit integration plan via sales or support; create apps and keys in the developer console after approval.

Are on-premises gateways supported?

Yes — local edge gateways for large groups provide cloud-consistent APIs offline/low-latency; architecture per project.

Is there a limit to the frequency of calls?

Per-app QPS and daily quotas; bulk projects may request increases. HTTP 429 on limit — use exponential backoff.

How are webhooks secured?

Payloads include HMAC signature and timestamp — verify and reject expired requests. Use HTTPS; optional IP allowlist.

How is it different from a cloud management platform?

Cloud platform for operator UI; Developer API for integration and automation with PMS, CRM, energy platforms — use together.

Need on-site training or after-sales support?

We offer API alignment training, project acceptance coaching, and lifecycle technical support.

Professional training services After-sales policy