Kembali ke Sokongan

API pembangun

Gambaran keseluruhan REST API, pengesahan dan dokumentasi model peranti.

Platform pembangun Poin Tulen Pintar menyediakan RESTful API standard dan SDK terbuka untuk integrator, vendor PMS/CRS dan ISV — merangkumi onboarding peranti, status bilik, kawalan adegan, data tenaga dan langganan acara. Melalui awan atau gateway tempatan, masukkan kawalan bilik tetamu Poin Tulen Pintar ke dalam operasi hotel dan sistem pengurusan bangunan anda dengan cepat.

Keupayaan platform

  • RESTful API

    Permintaan/respons JSON melalui HTTPS, laluan berversi — integrasi mudah untuk front-end, back-end dan sistem pihak ketiga.

  • SDK pelbagai bahasa

    Contoh Java, Python dan Node.js serta utiliti tandatangan untuk memendekkan kitaran integrasi dan go-live.

  • Acara Webhook

    Perubahan status bilik, amaran dan hasil adegan ditolak secara proaktif — dengan cuba semula dan pengesahan tandatangan.

  • Kotak pasir

    Penyewa ujian khusus dan peranti simulasi untuk integrasi pra-produksi dan pengesahan beban (mohon untuk aktifkan).

Modul API

Antara muka dikumpulkan mengikut domain perniagaan dengan kebenaran skop; definisi medan dan had kadar mengikut dokumentasi rasmi.

  • Peranti & titik

    Query status dalam talian RCU, panel dan sensor; baca/tulis nilai titik, I/O digital dan analog.

    • Senarai peranti
    • Baca/Tulis titik
    • Segerak pukal
  • Bilik & status

    Segerak check-in/out, DND, MUR, SOS dan status bilik lain; petakan ke nombor bilik PMS.

    • Segerak status
    • Pemetaan bilik
    • Pautan check-in
  • Adegan & pautan

    Cetus selamat datang, matikan kuasa bilik kosong, mod mesyuarat dan adegan lain; query hasil dan sebab kegagalan.

    • Pencetus adegan
    • Tugas berjadual
    • Query logik
  • Tenaga & laporan

    Agregat data kuasa dan HVAC mengikut bilik, tingkat atau kawasan awam; eksport antara muka laporan.

    • Query tenaga
    • Statistik
    • Eksport data
  • Amaran & ops

    Langgan amaran peranti offline, kerosakan komunikasi dan beban; integrasi dengan sistem tiket.

    • Senarai amaran
    • Webhook
    • Panggil balik tiket
  • Projek & akses

    Pengasingan penyewa pelbagai hotel/projek; AppKey, peranan dan pengurusan skop API.

    • Pentadbir penyewa
    • OAuth2
    • Log audit

Mula pantas

  1. Daftar akaun pembangun

    Hantar permintaan integrasi melalui jualan atau sokongan untuk AppKey / AppSecret.

  2. Konfigur URL panggil balik

    Daftar URL Webhook dalam konsol pembangun untuk acara status bilik dan amaran.

  3. Integrasi kotak pasir

    Panggil API dengan ID projek ujian untuk mengesahkan tandatangan, auth dan medan perniagaan.

  4. Go-live produksi

    Selepas penerimaan, tukar ke kredensial produksi dan pantau volum panggilan serta kadar ralat mengikut SLA.

Endpoint biasa

Contoh laluan REST tipikal; muat turun spesifikasi OpenAPI penuh dari pusat muat turun.

KaedahLaluanPenerangan
POST /v1/oauth/token Dapatkan token akses (Client Credentials)
GET /v1/projects/{id}/rooms Senarai bilik berhalaman dengan ringkasan status
GET /v1/projects/{id}/rooms/{roomNo}/devices Peranti dan status dalam talian untuk bilik
PUT /v1/projects/{id}/rooms/{roomNo}/scene/{sceneId} Cetus adegan (cth. selamat datang, matikan kuasa bilik kosong)
POST /v1/projects/{id}/rooms/{roomNo}/points Tulis pukal titik (suis, dimming, setpoint HVAC, dll.)
GET /v1/projects/{id}/energy/summary Ringkasan tenaga untuk julat masa
POST /v1/webhooks/subscriptions Daftar langganan Webhook (status bilik, amaran, dll.)

Protokol & ekosistem

Selain HTTP API, bas medan dan platform pihak ketiga disokong untuk integrasi hotel dan bangunan yang pelbagai.

REST / HTTPS

Gaya API seragam untuk awan dan gateway tempatan; pertukaran data JSON

BACnet / Modbus

Penukaran protokol untuk BMS, HVAC, meter dan subsistem lain

MQTT

Pelaporan peranti dan penghantaran arahan dalam senario lebar jalur rendah

KNX / plugin ekosistem

Bekerja dengan KNX, Home Assistant dan penyelesaian saling sambung lain

Proses onboarding

Hantar permintaan

Terangkan senario integrasi, volum panggilan dijangka dan garis masa go-live

Keluarkan kredensial

Kunci persekitaran kotak pasir dan produksi ditetapkan

Ujian integrasi

Sokongan teknikal membantu ujian API dan Webhook

Pelancaran produksi

Tukar ke produksi dan masukkan dalam pemantauan ops

Soalan lazim

Bagaimana dapat kunci API?

Tersedia untuk integrator kontrak dan pelanggan strategik. Hantar ringkasan integrasi melalui jualan atau sokongan; selepas kelulusan, cipta aplikasi dalam konsol pembangun untuk AppKey dan AppSecret.

Adakah deployment gateway tempatan disokong?

Ya. Kumpulan hotel besar boleh guna gateway edge tempatan dengan API konsisten awan dalam senario offline dan latensi rendah; seni bina ditentukan per projek.

Adakah had kadar?

QPS lalai dan kuota harian per aplikasi; projek pukal boleh minta peningkatan. Melebihi had mengembalikan 429 — laksanakan backoff eksponen.

Bagaimana Webhook dijamin selamat?

Payload acara termasuk tandatangan HMAC dan cap masa; sahkan tandatangan dan tolak permintaan lama. Guna endpoint HTTPS; senarai putih IP tersedia atas permintaan.

Apa bezanya dengan platform awan?

Platform awan ialah ops visual untuk kakitangan; API pembangun untuk integrasi sistem dan automasi — PMS, CRM, platform tenaga, dll. Kedua-duanya boleh digunakan bersama.

Perlu latihan di tapak atau sokongan selepas jualan?

Kami menawarkan latihan integrasi API, bimbingan penerimaan projek dan sokongan teknikal sepanjang kitaran hayat.