Pengenalan

Ini ialah API teras yang digunakan untuk tapak dan sistem yang menghadap awam. **Jika anda pembangun pihak ketiga yang ingin menggunakan API ini, sila hubungi sokongan Performance Hub supaya IP anda disenarai putih, jika tidak, anda akan dihadkan kadar dan/atau disekat jika terdapat terlalu banyak permintaan daripada perujuk / IP yang sama.**

URL Asas

https://uapi.gymsystems.co/

Pengesahan

Universal API menggunakan pengesahan kunci API melalui pengepala HTTP.

Sertakan kunci API Anda dalam pengepala X-API-Key bagi setiap permintaan.

Kendalikan kunci API Anda dengan berhati-hati kerana kunci ini memberikan akses penuh kepada akaun Anda! Jangan sekali-kali dedahkan kunci ini dalam repositori awam, aplikasi sisi klien atau di mana-mana tempat yang boleh menyebabkan kunci ini terjejas.

API hanya menerima sambungan HTTPS yang selamat. Permintaan HTTP biasa ditolak, begitu juga dengan sebarang permintaan yang tidak mempunyai kelayakan pengesahan yang betul.

Contoh Permintaan

curl https://uapi.gymsystems.co/api/v1/clubs \
  -H "X-API-Key: YOUR_API_KEY"

Borang Hubungan Umum

API yang digunakan untuk mesej 'hubungan umum' daripada laman web Example Club dan perkhidmatan luaran lain (seperti training camp dan sebagainya).

Parameter

organisationId `string` (pilihan) ID organisasi yang data kemudahannya ingin anda dapatkan - Ini digunakan untuk memastikan kami hanya mengembalikan kemudahan yang merupakan sebahagian daripada organisasi yang sama. leadForwarding `string` (pilihan) Patutkah kami memajukan e-mel ke mana-mana sistem pengurusan prospek (gymsales, gymleads dan sebagainya)? Ambil perhatian bahawa menetapkan kepada `onlyForwardIfConfigured` akan memajukan prospek ke mana-mana CRM - tetapi bukan ke e-mel utama kemudahan...

Badan Permintaan

Kandungan Hubungan Umum

Titik akhir

POST /api/v1/support/contact-submission

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/support/contact-submission \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Percubaan Percuma

Menjana permintaan halaman pendaratan 'percubaan percuma' untuk kemudahan yang ditentukan

Badan Permintaan

Kandungan Percubaan Percuma

Titik akhir

POST /api/v1/leads/free-trial

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/leads/free-trial \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Tempah Sesi Latihan

API yang digunakan untuk borang 'tempah sesi latihan' daripada laman web Example Club.

Badan Permintaan

Kandungan Tempah Sesi Latihan

Titik akhir

POST /api/v1/leads/book-a-workout

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/leads/book-a-workout \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Penyerahan Prospek Training Camp

Menjejaki penyerahan untuk mendaftarkan minat pengguna terhadap Training Camp daripada laman web utama kami - Maklumat ini kemudian digunakan untuk merujuk pengguna ke aplikasi/tapak trainingcamp.com dan bagi kemudahan untuk mendaftarkan ahli ke training camp.

Badan Permintaan

Kandungan Halaman

Titik akhir

POST /api/v1/leads/training-camp

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/leads/training-camp \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Mendapatkan metadata untuk satu kemudahan, atau semua kemudahan

API ini akan mengembalikan sama ada metadata kemudahan yang digunakan untuk memaparkan halaman kemudahan bagi satu kemudahan, atau semua kemudahan dalam pangkalan data.

Parameter

organisationId `string` (pilihan) ID organisasi yang data kemudahannya ingin anda dapatkan - Ini digunakan untuk memastikan kami hanya mengembalikan kemudahan yang merupakan sebahagian daripada organisasi yang sama. club `string` (pilihan) ID kemudahan yang ingin anda dapatkan... *NB* Anda boleh mengabaikannya jika anda ingin mengembalikan SEMUA kemudahan sebagai satu Objek JSON.

Titik akhir

GET /api/v1/club/data

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/club/data \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Mendapatkan metadata untuk satu kemudahan, atau semua kemudahan

API ini akan mengembalikan sama ada metadata kemudahan yang digunakan untuk memaparkan halaman kemudahan bagi satu kemudahan, atau semua kemudahan dalam pangkalan data.

Parameter

organisationId `string` (pilihan) ID organisasi yang data kemudahannya ingin anda dapatkan - Ini digunakan untuk memastikan kami hanya mengembalikan kemudahan yang merupakan sebahagian daripada organisasi yang sama. club `string` (pilihan) ID kemudahan yang ingin anda dapatkan... *NB* Anda boleh mengabaikannya jika anda ingin mengembalikan SEMUA kemudahan sebagai satu Objek JSON.

Titik akhir

GET /api/v2/club/data

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v2/club/data \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Cari kemudahan mengikut bandar dan lat/lng

Lakukan carian kemudahan berdekatan, berdasarkan Latitud, Longitud dan Istilah Carian anda (seperti Kawasan Kejiranan, Pekan atau Bandar)

Parameter

geogroup `string` (pilihan) Mengembalikan senarai bandar/negeri/negara 'berkumpulan' tempat kemudahan berada search `string` (pilihan) Istilah untuk dicari - Secara amnya ini ialah sama ada: Pekan, Bandar, Kawasan Kejiranan atau Poskod limit `string` (pilihan) Had bilangan hasil origin `string` (pilihan) Latitud & Longitud yang menjadi asas carian anda - Ini penting apabila mencari pekan/kawasan kejiranan dengan nama yang sama, tetapi di negara/bandar berbeza tempat kami mempunyai berbilang kemudahan - Iaitu `Southbank Example City` atau `Southbank Example City 2` organisationId `string` (pilihan) ID organisasi untuk menapis kemudahan - Ini digunakan untuk memastikan kami hanya mengembalikan kemudahan yang merupakan sebahagian daripada organisasi yang sama.

Titik akhir

GET /api/v1/club/geosearch

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/club/geosearch \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Menyenaraikan ulasan yang disematkan untuk satu kemudahan

API ini akan mengembalikan ulasan kemudahan yang disematkan.

Parameter

club `string` (pilihan) ID kemudahan yang ingin anda dapatkan

Titik akhir

GET /api/v2/club/reviews

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v2/club/reviews \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan konfigurasi aplikasi yang ditetapkan dalam kemudahan tertentu

Parameter

clubID `string` (pilihan) ID kemudahan yang ingin anda dapatkan appID `string` (pilihan) ID aplikasi yang ingin anda dapatkan

Titik akhir

GET /api/v1/club/apps/config

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/club/apps/config \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Latitud & Longitud berdasarkan IP Pengguna

Mengembalikan anggaran latitud & longitud IP pengguna berdasarkan Pangkalan Data GeoIP Maxmind.

Titik akhir

GET /api/v1/geo/ip

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/geo/ip \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Menghuraikan rentetan alamat dan mengembalikannya sebagai objek.

Tukar rentetan alamat kepada Objek yang terdiri daripada jalan, bandar, negeri dan poskod.

Badan Permintaan

Kandungan Halaman

Titik akhir

POST /api/v1/user/address-parser

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/user/address-parser \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Menjejaki e-mel yang diserahkan dalam pangkalan data pusat kami.

Menjejaki e-mel yang diserahkan ke pelbagai bahagian laman web kami _(iaitu API dalaman, Mailchimp, Hubspot dan sebagainya)_ dan/atau API pihak ketiga dalam Jadual DynamoDB pusat kami, membolehkan kami melakukan analisis dan penyasaran ahli yang lebih terperinci daripada Ekosistem Example Club.

Badan Permintaan

Kandungan Halaman

Titik akhir

POST /api/v1/analytics/track-email

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/analytics/track-email \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Menghantar data ke Graylog

Menghantar data daripada pelbagai perkhidmatan bahagian hadapan ke sistem Pengurusan Log dalaman kami (Graylog).

Badan Permintaan

Kandungan Halaman

Titik akhir

POST /api/v1/analytics/beacon

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/analytics/beacon \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Menyemak sama ada ID Myzone Belt didaftarkan dengan kemudahan

Mengembalikan respons true atau false sama ada ID Myzone Belt dikaitkan dengan ID kemudahan yang diberikan.

Parameter

club `string` (pilihan) ID kemudahan untuk dibuat pertanyaan beltid `string` (pilihan) ID Myzone Belt untuk dicari

Titik akhir

GET /api/v1/myzone/belt-registered

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/myzone/belt-registered \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Kekerapan Leretan Lawatan

Dapatkan senarai leretan lawatan oleh ahli dalam tempoh tertentu

Parameter

start_date `string` (pilihan) Tarikh mula tempoh yang digunakan untuk menapis lawatan ahli end_date `string` (pilihan) Tarikh tamat tempoh yang digunakan untuk menapis lawatan ahli club `string` (pilihan) Kemudahan tertentu tempat ahli melanggan, untuk menapis kemudahan tempat ahli membuat leretan email `string` (pilihan) E-mel tertentu yang digunakan untuk leretan lawatan

Titik akhir

GET /api/v1/members/swipes/frequency

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/members/swipes/frequency \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Webhook untuk peristiwa daftar masuk GymMaster

Titik akhir

POST /api/v1/webhooks/gymmaster/checkin

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/webhooks/gymmaster/checkin \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Daftar/Hantar ID Peranti

Menyimpan UUID, IP dan Screen ID (ID Peranti) komputer Display Screens dalam pangkalan data, membolehkan peranti dikaitkan melalui Performance Hub.

Badan Permintaan

Objek JSON perlu dihantar ke titik akhir ini yang mengandungi maklumat tentang peranti, seperti IP dan UUIDnya

Titik akhir

POST /api/v1/devices/dashkiosk/register

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/dashkiosk/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Menetapkan keadaan butang kecemasan

Menetapkan keadaan butang kecemasan yang dikaitkan dengan kemudahan kepada sama ada `true|false`. Ambil perhatian bahawa anda hanya boleh menukar keadaan butang yang didaftarkan dengan kemudahan. Ini tidak akan berfungsi untuk peranti yang belum disediakan.

Badan Permintaan

Objek JSON Keadaan Penggera Butang Kecemasan

Titik akhir

POST /api/v1/devices/duress/setAlarmState

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/duress/setAlarmState \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Mengembalikan Butang Kecemasan yang dikaitkan dengan Kemudahan

Kembalikan tatasusunan Butang Kecemasan yang dikaitkan dengan kemudahan untuk diimbas bagi kemas kini..

Parameter

clubID `string` (wajib) ID kemudahan untuk dibuat pertanyaan

Titik akhir

GET /api/v1/devices/duress/getDuressButtons/{clubID}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/devices/duress/getDuressButtons/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Mengemas kini Metadata Peranti

Mengemas kini metadata peranti untuk UUID. Ambil perhatian bahawa tiada pengesahan diperlukan untuk menghantar data ke fungsi ini, jadi data tidak sepatutnya mengandungi sebarang maklumat sensitif.

Badan Permintaan

Objek JSON perlu dihantar ke titik akhir ini yang mengandungi maklumat tentang peranti, seperti Maklumat OS, Metrik Wifi dan sebagainya...

Titik akhir

POST /api/v1/devices/metadata/beacon

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/metadata/beacon \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Mengembalikan maklumat tentang paparan berdasarkan UUID peranti.

Mendapatkan konfigurasi untuk peranti berdasarkan UUID peranti, dan mengembalikan maklumat seperti pusingan yang dikaitkan dengan peranti dan kandungan yang harus dipaparkan.

Parameter

uuid `string` (wajib) UUID peranti yang konfigurasinya sedang diambil

Titik akhir

GET /api/v1/devices/displayconfig/{uuid}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/devices/displayconfig/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Mengembalikan maklumat konfigurasi untuk peranti berdasarkan UUID.

Mengambil konfigurasi untuk peranti daripada berbilang jadual (Display Screens, Peranti IoT, Peranti CCTV) menggunakan UUID peranti, dan mengembalikan butiran konfigurasi yang berkaitan sebagai JSON.

Parameter

uuid `string` (wajib) UUID peranti yang konfigurasinya hendak diambil

Titik akhir

GET /api/v1/devices/config/{uuid}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/devices/config/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Daftar Peranti BLE Beacon

Menyimpan maklumat peranti BLE Beacon ke dalam pangkalan data kami

Badan Permintaan

Data Peranti BLE Beacon

Titik akhir

POST /api/v1/devices/blebeacon/register

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/blebeacon/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Menyenaraikan Peranti CCTV yang dikaitkan dengan ClubID

Menyenaraikan butiran peranti CCTV peringkat tinggi yang dikaitkan dengan ClubID - Ambil perhatian bahawa hanya maklumat generik/peringkat tinggi dikembalikan melalui API ini, seperti alamat IP setempat peranti dan sama ada ia dalam talian|luar talian. API Performance Hub mesti digunakan untuk butiran peranti lanjutan.

Parameter

clubID `string` (wajib) ID kemudahan untuk dibuat pertanyaan

Titik akhir

GET /api/v1/devices/cctv/list-devices/{clubID}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/devices/cctv/list-devices/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Daftar Peranti CCTV

Menyimpan maklumat peranti CCTV ke dalam pangkalan data kami

Badan Permintaan

Data Peranti CCTV

Titik akhir

POST /api/v1/devices/cctv/register

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Daftar Peranti AI Edge Processor

Menyimpan maklumat peranti AI Edge Processor ke dalam pangkalan data kami

Badan Permintaan

Data Peranti AI Edge Processor

Titik akhir

POST /api/v1/devices/ai-edge-processor/register

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/ai-edge-processor/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Menjana URL yang ditandatangani untuk menerima muat naik rakaman CCTV

Menjana URL S3 yang ditandatangani untuk membolehkan klien memuat naik rakaman CCTV terus ke S3 untuk pascapemprosesan.

Badan Permintaan

Metadata peranti

Titik akhir

POST /api/v1/devices/cctv/generate-upload-token

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/generate-upload-token \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Memberitahu S3 bahawa muat naik berbilang bahagian telah selesai

Memberitahu S3 bahawa muat naik berbilang bahagian telah diselesaikan oleh klien

Badan Permintaan

Metadata peranti

Titik akhir

POST /api/v1/devices/cctv/complete-upload

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/complete-upload \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Respons

{}

Hantar arahan Sonos ke peranti Sonos kemudahan

Parameter

clubID `string` (wajib) ID kemudahan untuk dibuat pertanyaan

Titik akhir

POST /api/v1/devices/audio-control/command/{clubID}

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/devices/audio-control/command/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan tetapan Kawalan Audio kemudahan

Parameter

clubID `string` (wajib) ID kemudahan untuk dibuat pertanyaan

Titik akhir

GET /api/v1/devices/audio-control/config/{clubID}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/devices/audio-control/config/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Cipta token akses sementara

Titik akhir

POST /api/v1/temporary-access/token

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/temporary-access/token \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Item Strim Langsung Muzik

Titik akhir

GET /api/v1/streams

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/streams \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Data Item Strim Langsung Muzik

Parameter

id `string` (wajib) ID unik yang mengenal pasti item strim

Titik akhir

GET /api/v1/streams/{id}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/streams/{id} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Item Soalan Lazim

Parameter

location `string` (pilihan) Lokasi tempat anda mahu item soalan lazim dipaparkan. cth: laman web utama (website_main). categories `string` (pilihan) Kategori untuk item soalan lazim. status `string` (pilihan) Status item

Titik akhir

GET /api/v1/faqs

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/faqs \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Item Soalan Lazim

Parameter

category `string` (wajib) Penapis kategori

Titik akhir

GET /api/v1/faqs/{category}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/faqs/{category} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Item Akhbar

Parameter

location `string` (pilihan) Lokasi tempat anda mahu item akhbar dipaparkan. cth: laman web utama (website_main). status `string` (pilihan) Status item

Titik akhir

GET /api/v1/press

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/press \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Pemetaan E-mel

Titik akhir

GET /api/v1/email-mapping

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/email-mapping \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Kod Penjejakan Tersuai

Parameter

clubID `string` (wajib) ID kemudahan atau lokasi kemudahan. cth: Milton

Titik akhir

GET /api/v1/customtracking/{clubID}

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/customtracking/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Dapatkan Item Halaman Pendaratan

Parameter

region `string` (pilihan) Kawasan tempat kemudahan berada. cth: AU, NZ, US club `string` (pilihan) ID kemudahan, pengecam unik kemudahan slug `string` (pilihan) Bahagian terakhir alamat URL yang berfungsi sebagai pengecam unik halaman

Titik akhir

GET /api/v1/landing-pages

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/landing-pages \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Borang Hubungan Laman Web Performance Hub

Menerima penyerahan borang daripada laman web Performance Hub (permintaan demo, pertanyaan jualan, pesanan akses awal) dan menghantar e-mel pemberitahuan melalui SES.

Titik akhir

POST /api/v1/performancehub/website-contact

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/performancehub/website-contact \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Minta OTP Door/Gate Access

Menghantar kod pengesahan sekali guna ke telefon atau e-mel yang diberikan. Sentiasa membalas 200 untuk mengelakkan penghitungan pengecam. Kadar dihadkan bagi setiap pengecam dan setiap IP (tetingkap gelongsor Redis).

Titik akhir

POST /api/v1/door-gate-access/auth/otp/request

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/otp/request \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Sahkan OTP Door/Gate Access dan keluarkan token

Mengesahkan OTP, menentukan profil orang yang dipautkan merentas semua kemudahan, dan mengembalikan JWT jangka pendek + token muat semula legap yang berputar.

Titik akhir

POST /api/v1/door-gate-access/auth/otp/verify

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/otp/verify \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Putar token muat semula Door/Gate Access

Titik akhir

POST /api/v1/door-gate-access/auth/refresh

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/refresh \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Batalkan token muat semula Door/Gate Access

Titik akhir

POST /api/v1/door-gate-access/auth/logout

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/logout \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Sesi Door/Gate Access semasa

Titik akhir

GET /api/v1/door-gate-access/me

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Kemas kini medan profil yang boleh diedit

Mengemas kini firstName / lastName pada setiap baris ph-door-access-users yang sepadan dengan pengecam JWT. E-mel dan telefon tidak boleh diubah di sini.

Titik akhir

PATCH /api/v1/door-gate-access/me

Contoh Permintaan

curl -X PATCH https://uapi.gymsystems.co//api/v1/door-gate-access/me \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Senaraikan kemudahan untuk pengguna Door/Gate Access

Titik akhir

GET /api/v1/door-gate-access/me/facilities

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/facilities \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Tetapkan kemudahan yang sedang dipilih oleh pengguna

Titik akhir

POST /api/v1/door-gate-access/me/facility

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/me/facility \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Senaraikan pintu yang boleh dibuka oleh pengguna di kemudahan

Parameter

facilityId `string` (pilihan) Pengecam kemudahan (clubID).

Titik akhir

GET /api/v1/door-gate-access/me/doors

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/doors \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Percubaan buka kunci terkini untuk pengguna semasa

Titik akhir

GET /api/v1/door-gate-access/me/access-history

Contoh Permintaan

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/access-history \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}

Buka kunci pintu daripada aplikasi mudah alih Door/Gate Access

Semakan ketat di bahagian pelayan sebelum menerbitkan ke MQTT. Pelayan ialah sumber kebenaran bagi peraturan kekal, Access Time Windows tambahan, sekatan pintu yang jelas, mod penyelenggaraan dan geofence. Keadaan klien hanya untuk UX.

Parameter

doorId `string` (wajib) balenaUUID pengawal pintu.

Titik akhir

POST /api/v1/door-gate-access/doors/{doorId}/unlock

Contoh Permintaan

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/doors/{doorId}/unlock \
  -H "x-api-key: YOUR_API_KEY"

Respons

{}