บทนำ

นี่คือ API หลักที่ใช้สำหรับเว็บไซต์และระบบที่เปิดให้บุคคลทั่วไปใช้งาน **หากคุณเป็นนักพัฒนาบุคคลที่สามที่ต้องการใช้ API นี้ โปรดติดต่อฝ่ายสนับสนุนของ Performance Hub เพื่อให้เพิ่ม IP ของคุณในรายการที่อนุญาต มิฉะนั้นคุณจะถูกจำกัดอัตราและ/หรือถูกบล็อกหากมีคำขอจาก referrer / IP เดียวกันมากเกินไป**

URL หลัก

https://uapi.gymsystems.co/

การยืนยันตัวตน

Universal API ใช้การยืนยันตัวตนด้วยคีย์ API ผ่านส่วนหัว HTTP

ใส่คีย์ API ของคุณในส่วนหัว X-API-Key ทุกครั้งที่ส่งคำขอ

โปรดดูแลคีย์ API ของคุณอย่างระมัดระวัง เนื่องจากคีย์เหล่านี้ให้สิทธิ์เข้าถึงบัญชีของคุณได้ทั้งหมด ห้ามเปิดเผยคีย์เหล่านี้ในที่เก็บโค้ดสาธารณะ แอปพลิเคชันฝั่งไคลเอนต์ หรือที่ใดก็ตามที่อาจทำให้คีย์รั่วไหล

API รับเฉพาะการเชื่อมต่อ HTTPS ที่ปลอดภัยเท่านั้น คำขอผ่าน HTTP ธรรมดาจะถูกปฏิเสธ เช่นเดียวกับคำขอที่ไม่มีข้อมูลรับรองการยืนยันตัวตนที่ถูกต้อง

ตัวอย่างคำขอ

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

แบบฟอร์มติดต่อทั่วไป

API ที่ใช้สำหรับข้อความ 'ติดต่อทั่วไป' จากเว็บไซต์ Example Club และบริการอื่นๆ ที่เปิดให้บุคคลภายนอกใช้งาน (เช่น training camp เป็นต้น)

พารามิเตอร์

organisationId `string` (ไม่บังคับ) ID ขององค์กรที่คุณต้องการดึงข้อมูลสถานที่ ใช้เพื่อให้แน่ใจว่าระบบจะส่งกลับเฉพาะสถานที่ที่อยู่ในองค์กรเดียวกันเท่านั้น leadForwarding `string` (ไม่บังคับ) ควรส่งต่ออีเมลไปยังระบบจัดการลีด (gymsales, gymleads เป็นต้น) หรือไม่ หมายเหตุ การตั้งค่าเป็น `onlyForwardIfConfigured` จะส่งต่อลีดไปยัง CRM ใดก็ได้ แต่จะไม่ส่งไปยังอีเมลหลักของสถานที่

เนื้อหาคำขอ

เนื้อหาแบบฟอร์มติดต่อทั่วไป

ปลายทาง (Endpoint)

POST /api/v1/support/contact-submission

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ทดลองใช้ฟรี

สร้างคำขอหน้า Landing Page 'ทดลองใช้ฟรี' สำหรับสถานที่ที่ระบุ

เนื้อหาคำขอ

เนื้อหาคำขอทดลองใช้ฟรี

ปลายทาง (Endpoint)

POST /api/v1/leads/free-trial

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

จองการออกกำลังกาย

API ที่ใช้สำหรับแบบฟอร์ม 'จองการออกกำลังกาย' จากเว็บไซต์ Example Club

เนื้อหาคำขอ

เนื้อหาคำขอจองการออกกำลังกาย

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

การส่งลีดของ Training Camp

ติดตามการส่งแบบฟอร์มแสดงความสนใจ Training Camp ของผู้ใช้จากเว็บไซต์หลักของเรา ข้อมูลนี้จะใช้เพื่อแนะนำผู้ใช้ไปยังแอป/เว็บไซต์ trainingcamp.com และให้สถานที่ลงทะเบียนสมาชิกเข้าร่วม Training Camp

เนื้อหาคำขอ

เนื้อหาหน้า

ปลายทาง (Endpoint)

POST /api/v1/leads/training-camp

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ดึงเมทาดาทาของสถานที่หนึ่งแห่ง หรือของทุกสถานที่

API นี้จะส่งกลับเมทาดาทาของสถานที่ที่ใช้แสดงหน้าสถานที่สำหรับสถานที่หนึ่งแห่ง หรือของทุกสถานที่ในฐานข้อมูล

พารามิเตอร์

organisationId `string` (ไม่บังคับ) ID ขององค์กรที่คุณต้องการดึงข้อมูลสถานที่ ใช้เพื่อให้แน่ใจว่าระบบจะส่งกลับเฉพาะสถานที่ที่อยู่ในองค์กรเดียวกันเท่านั้น club `string` (ไม่บังคับ) ID ของสถานที่ที่คุณต้องการดึง *หมายเหตุ* คุณสามารถละค่านี้ได้หากต้องการส่งกลับทุกสถานที่เป็นออบเจ็กต์ JSON เดียว

ปลายทาง (Endpoint)

GET /api/v1/club/data

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงเมทาดาทาของสถานที่หนึ่งแห่ง หรือของทุกสถานที่

API นี้จะส่งกลับเมทาดาทาของสถานที่ที่ใช้แสดงหน้าสถานที่สำหรับสถานที่หนึ่งแห่ง หรือของทุกสถานที่ในฐานข้อมูล

พารามิเตอร์

organisationId `string` (ไม่บังคับ) ID ขององค์กรที่คุณต้องการดึงข้อมูลสถานที่ ใช้เพื่อให้แน่ใจว่าระบบจะส่งกลับเฉพาะสถานที่ที่อยู่ในองค์กรเดียวกันเท่านั้น club `string` (ไม่บังคับ) ID ของสถานที่ที่คุณต้องการดึง *หมายเหตุ* คุณสามารถละค่านี้ได้หากต้องการส่งกลับทุกสถานที่เป็นออบเจ็กต์ JSON เดียว

ปลายทาง (Endpoint)

GET /api/v2/club/data

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ค้นหาสถานที่ตามเมืองและละติจูด/ลองจิจูด

ค้นหาสถานที่ใกล้เคียงตามละติจูด ลองจิจูด และคำค้นหาของคุณ (เช่น ชานเมือง เมืองเล็ก หรือเมือง)

พารามิเตอร์

geogroup `string` (ไม่บังคับ) ส่งกลับรายการเมือง/รัฐ/ประเทศที่ 'จัดกลุ่ม' แล้วซึ่งมีสถานที่ตั้งอยู่ search `string` (ไม่บังคับ) คำที่ต้องการค้นหา โดยทั่วไปจะเป็น: เมืองเล็ก เมือง ชานเมือง หรือรหัสไปรษณีย์ limit `string` (ไม่บังคับ) จำนวนผลลัพธ์สูงสุด origin `string` (ไม่บังคับ) ละติจูดและลองจิจูดที่ใช้เป็นฐานในการค้นหา ซึ่งสำคัญมากเมื่อค้นหาเมืองเล็ก/ชานเมืองที่มีชื่อเดียวกันแต่อยู่ในประเทศ/เมืองต่างกันที่เรามีหลายสถานที่ เช่น `Southbank Example City` หรือ `Southbank Example City 2` organisationId `string` (ไม่บังคับ) ID ขององค์กรที่ใช้กรองสถานที่ ใช้เพื่อให้แน่ใจว่าระบบจะส่งกลับเฉพาะสถานที่ที่อยู่ในองค์กรเดียวกันเท่านั้น

ปลายทาง (Endpoint)

GET /api/v1/club/geosearch

ตัวอย่างคำขอ

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

การตอบกลับ

{}

แสดงรายการรีวิวที่ปักหมุดของสถานที่หนึ่งแห่ง

API นี้จะส่งกลับรีวิวที่ปักหมุดของสถานที่

พารามิเตอร์

club `string` (ไม่บังคับ) ID ของสถานที่ที่คุณต้องการดึง

ปลายทาง (Endpoint)

GET /api/v2/club/reviews

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงการกำหนดค่าของแอปที่ตั้งไว้ในสถานที่ที่ระบุ

ดึงการกำหนดค่าของแอปที่ตั้งไว้ในสถานที่ที่ระบุ

พารามิเตอร์

clubID `string` (ไม่บังคับ) ID ของสถานที่ที่คุณต้องการดึง appID `string` (ไม่บังคับ) ID ของแอปที่คุณต้องการดึง

ปลายทาง (Endpoint)

GET /api/v1/club/apps/config

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ละติจูดและลองจิจูดตาม IP ของผู้ใช้

ส่งกลับละติจูดและลองจิจูดโดยประมาณของ IP ของผู้ใช้ตามฐานข้อมูล GeoIP ของ Maxmind

ปลายทาง (Endpoint)

GET /api/v1/geo/ip

ตัวอย่างคำขอ

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

การตอบกลับ

{}

แยกวิเคราะห์สตริงที่อยู่และส่งกลับเป็นออบเจ็กต์

แปลงสตริงที่อยู่เป็นออบเจ็กต์ที่ประกอบด้วยถนน เมือง รัฐ และรหัสไปรษณีย์

เนื้อหาคำขอ

เนื้อหาหน้า

ปลายทาง (Endpoint)

POST /api/v1/user/address-parser

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ติดตามอีเมลที่ส่งเข้ามาในฐานข้อมูลส่วนกลางของเรา

ติดตามอีเมลที่ส่งเข้ามายังส่วนต่างๆ ของเว็บไซต์ของเรา _(เช่น API ภายใน, Mailchimp, Hubspot เป็นต้น)_ และ/หรือ API ของบุคคลที่สามในตาราง DynamoDB ส่วนกลางของเรา ช่วยให้วิเคราะห์และกำหนดเป้าหมายสมาชิกจากระบบนิเวศ Example Club ได้ละเอียดยิ่งขึ้น

เนื้อหาคำขอ

เนื้อหาหน้า

ปลายทาง (Endpoint)

POST /api/v1/analytics/track-email

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ส่งข้อมูลไปยัง Graylog

ส่งข้อมูลจากบริการฝั่งฟรอนต์เอนด์ต่างๆ ไปยังระบบจัดการบันทึกภายในของเรา (Graylog)

เนื้อหาคำขอ

เนื้อหาหน้า

ปลายทาง (Endpoint)

POST /api/v1/analytics/beacon

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ตรวจสอบว่า Myzone Belt ID ลงทะเบียนกับสถานที่หรือไม่

ส่งกลับค่า true หรือ false ว่า Myzone Belt ID เชื่อมโยงกับ Club ID ที่ระบุหรือไม่

พารามิเตอร์

club `string` (ไม่บังคับ) ID ของสถานที่ที่ต้องการสืบค้น beltid `string` (ไม่บังคับ) ID ของ Myzone Belt ที่ต้องการค้นหา

ปลายทาง (Endpoint)

GET /api/v1/myzone/belt-registered

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงความถี่ของการรูดบัตรเข้าใช้

ดึงรายการการรูดบัตรเข้าใช้ของสมาชิกในช่วงเวลาที่กำหนด

พารามิเตอร์

start_date `string` (ไม่บังคับ) วันเริ่มต้นของช่วงเวลาที่ใช้กรองการเข้าใช้ของสมาชิก end_date `string` (ไม่บังคับ) วันสิ้นสุดของช่วงเวลาที่ใช้กรองการเข้าใช้ของสมาชิก club `string` (ไม่บังคับ) สถานที่ที่สมาชิกสมัครไว้ ใช้กรองว่าสมาชิกรูดบัตรเข้าที่สถานที่ใด email `string` (ไม่บังคับ) อีเมลที่ใช้สำหรับการรูดบัตรเข้าใช้

ปลายทาง (Endpoint)

GET /api/v1/members/swipes/frequency

ตัวอย่างคำขอ

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

การตอบกลับ

{}

Webhook สำหรับเหตุการณ์การเช็กอินของ GymMaster

Webhook สำหรับเหตุการณ์การเช็กอินของ GymMaster

ปลายทาง (Endpoint)

POST /api/v1/webhooks/gymmaster/checkin

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ลงทะเบียน/ส่ง Device ID

จัดเก็บ UUID, IP และ Screen ID (Device ID) ของคอมพิวเตอร์ Display Screens ในฐานข้อมูล เพื่อให้เชื่อมโยงอุปกรณ์ผ่าน Performance Hub ได้

เนื้อหาคำขอ

ควรส่งออบเจ็กต์ JSON ไปยังปลายทางนี้ซึ่งมีข้อมูลเกี่ยวกับอุปกรณ์ เช่น IP และ UUID

ปลายทาง (Endpoint)

POST /api/v1/devices/dashkiosk/register

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ตั้งค่าสถานะของปุ่มขอความช่วยเหลือฉุกเฉิน

ตั้งค่าสถานะเป็น `true|false` ของปุ่มขอความช่วยเหลือฉุกเฉินที่เชื่อมโยงกับสถานที่ หมายเหตุ คุณสามารถเปลี่ยนสถานะได้เฉพาะปุ่มที่ลงทะเบียนกับสถานที่แล้วเท่านั้น ใช้ไม่ได้กับอุปกรณ์ที่ยังไม่ได้ตั้งค่า

เนื้อหาคำขอ

ออบเจ็กต์ JSON สถานะสัญญาณเตือนของปุ่มขอความช่วยเหลือฉุกเฉิน

ปลายทาง (Endpoint)

POST /api/v1/devices/duress/setAlarmState

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ส่งกลับปุ่มขอความช่วยเหลือฉุกเฉินที่เชื่อมโยงกับสถานที่

ส่งกลับอาร์เรย์ของปุ่มขอความช่วยเหลือฉุกเฉินที่เชื่อมโยงกับสถานที่เพื่อใช้ตรวจหาการอัปเดต

พารามิเตอร์

clubID `string` (จำเป็น) ID ของสถานที่ที่ต้องการสืบค้น

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

อัปเดตเมทาดาทาของอุปกรณ์

อัปเดตเมทาดาทาของอุปกรณ์สำหรับ UUID หมายเหตุ ฟังก์ชันนี้ไม่ต้องยืนยันตัวตนในการส่งข้อมูล ดังนั้นข้อมูลไม่ควรมีข้อมูลที่ละเอียดอ่อนใดๆ

เนื้อหาคำขอ

ควรส่งออบเจ็กต์ JSON ไปยังปลายทางนี้ซึ่งมีข้อมูลเกี่ยวกับอุปกรณ์ เช่น ข้อมูลระบบปฏิบัติการ ตัวชี้วัด Wi-Fi เป็นต้น

ปลายทาง (Endpoint)

POST /api/v1/devices/metadata/beacon

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ส่งกลับข้อมูลเกี่ยวกับจอแสดงผลตาม UUID ของอุปกรณ์

ดึงการกำหนดค่าของอุปกรณ์ตาม UUID ของอุปกรณ์ และส่งกลับข้อมูล เช่น รอบที่เชื่อมโยงกับอุปกรณ์และเนื้อหาที่ควรแสดง

พารามิเตอร์

uuid `string` (จำเป็น) UUID ของอุปกรณ์ที่ดึงการกำหนดค่า

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ส่งกลับข้อมูลการกำหนดค่าของอุปกรณ์ตาม UUID

ดึงการกำหนดค่าของอุปกรณ์จากหลายตาราง (Display Screens, อุปกรณ์ IoT, อุปกรณ์กล้องวงจรปิด) โดยใช้ UUID ของอุปกรณ์ และส่งกลับรายละเอียดการกำหนดค่าที่เกี่ยวข้องเป็น JSON

พารามิเตอร์

uuid `string` (จำเป็น) UUID ของอุปกรณ์ที่ต้องการดึงการกำหนดค่า

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ลงทะเบียนอุปกรณ์ BLE Beacon

บันทึกข้อมูลอุปกรณ์ BLE Beacon ลงในฐานข้อมูลของเรา

เนื้อหาคำขอ

ข้อมูลอุปกรณ์ BLE Beacon

ปลายทาง (Endpoint)

POST /api/v1/devices/blebeacon/register

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

แสดงรายการอุปกรณ์กล้องวงจรปิดที่เชื่อมโยงกับ ClubID

แสดงรายการรายละเอียดระดับสูงของอุปกรณ์กล้องวงจรปิดที่เชื่อมโยงกับ ClubID หมายเหตุ API นี้ส่งกลับเฉพาะข้อมูลทั่วไป/ระดับสูง เช่น ที่อยู่ IP ภายในของอุปกรณ์และสถานะออนไลน์|ออฟไลน์ ต้องใช้ Performance Hub API สำหรับรายละเอียดอุปกรณ์ขั้นสูง

พารามิเตอร์

clubID `string` (จำเป็น) ID ของสถานที่ที่ต้องการสืบค้น

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ลงทะเบียนอุปกรณ์กล้องวงจรปิด

บันทึกข้อมูลอุปกรณ์กล้องวงจรปิดลงในฐานข้อมูลของเรา

เนื้อหาคำขอ

ข้อมูลอุปกรณ์กล้องวงจรปิด

ปลายทาง (Endpoint)

POST /api/v1/devices/cctv/register

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ลงทะเบียนอุปกรณ์ AI Edge Processor

บันทึกข้อมูลอุปกรณ์ AI Edge Processor ลงในฐานข้อมูลของเรา

เนื้อหาคำขอ

ข้อมูลอุปกรณ์ AI Edge Processor

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

สร้าง URL ที่ลงนามแล้วสำหรับรับการอัปโหลดวิดีโอบันทึกจากกล้องวงจรปิด

สร้าง URL ของ S3 ที่ลงนามแล้ว เพื่อให้ไคลเอ็นต์อัปโหลดวิดีโอบันทึกจากกล้องวงจรปิดไปยัง S3 โดยตรงสำหรับการประมวลผลภายหลัง

เนื้อหาคำขอ

เมทาดาทาของอุปกรณ์

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

แจ้ง S3 ว่าการอัปโหลดแบบหลายส่วนเสร็จสมบูรณ์แล้ว

แจ้ง S3 ว่าไคลเอ็นต์อัปโหลดแบบหลายส่วนเสร็จสมบูรณ์แล้ว

เนื้อหาคำขอ

เมทาดาทาของอุปกรณ์

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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 '{}'

การตอบกลับ

{}

ส่งคำสั่ง Sonos ไปยังอุปกรณ์ Sonos ของสถานที่

ส่งคำสั่ง Sonos ไปยังอุปกรณ์ Sonos ของสถานที่

พารามิเตอร์

clubID `string` (จำเป็น) ID ของสถานที่ที่ต้องการสืบค้น

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงการตั้งค่าการควบคุมเสียงของสถานที่

ดึงการตั้งค่าการควบคุมเสียงของสถานที่

พารามิเตอร์

clubID `string` (จำเป็น) ID ของสถานที่ที่ต้องการสืบค้น

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

สร้างโทเค็นการเข้าถึงชั่วคราว

สร้างโทเค็นการเข้าถึงชั่วคราว

ปลายทาง (Endpoint)

POST /api/v1/temporary-access/token

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงรายการไลฟ์สตรีมเพลง

ดึงรายการไลฟ์สตรีมเพลง

ปลายทาง (Endpoint)

GET /api/v1/streams

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงข้อมูลรายการไลฟ์สตรีมเพลง

ดึงข้อมูลรายการไลฟ์สตรีมเพลง

พารามิเตอร์

id `string` (จำเป็น) id ที่ไม่ซ้ำกันซึ่งระบุรายการสตรีม

ปลายทาง (Endpoint)

GET /api/v1/streams/{id}

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงรายการคำถามที่พบบ่อย

ดึงรายการคำถามที่พบบ่อย

พารามิเตอร์

location `string` (ไม่บังคับ) ตำแหน่งที่คุณต้องการให้รายการคำถามที่พบบ่อยปรากฏ เช่น เว็บไซต์หลัก (website_main) categories `string` (ไม่บังคับ) หมวดหมู่ของรายการคำถามที่พบบ่อย status `string` (ไม่บังคับ) สถานะของรายการ

ปลายทาง (Endpoint)

GET /api/v1/faqs

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงรายการคำถามที่พบบ่อย

ดึงรายการคำถามที่พบบ่อย

พารามิเตอร์

category `string` (จำเป็น) ตัวกรองหมวดหมู่

ปลายทาง (Endpoint)

GET /api/v1/faqs/{category}

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงรายการข่าวประชาสัมพันธ์

ดึงรายการข่าวประชาสัมพันธ์

พารามิเตอร์

location `string` (ไม่บังคับ) ตำแหน่งที่คุณต้องการให้รายการข่าวประชาสัมพันธ์ปรากฏ เช่น เว็บไซต์หลัก (website_main) status `string` (ไม่บังคับ) สถานะของรายการ

ปลายทาง (Endpoint)

GET /api/v1/press

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงการแมปอีเมล

ดึงการแมปอีเมล

ปลายทาง (Endpoint)

GET /api/v1/email-mapping

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงโค้ดติดตามที่กำหนดเอง

ดึงโค้ดติดตามที่กำหนดเอง

พารามิเตอร์

clubID `string` (จำเป็น) ID ของสถานที่หรือตำแหน่งที่ตั้งของสถานที่ เช่น Milton

ปลายทาง (Endpoint)

GET /api/v1/customtracking/{clubID}

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ดึงรายการ Landing Page

ดึงรายการ Landing Page

พารามิเตอร์

region `string` (ไม่บังคับ) ภูมิภาคที่สถานที่สังกัดอยู่ เช่น AU, NZ, US club `string` (ไม่บังคับ) Club ID ตัวระบุที่ไม่ซ้ำกันของสถานที่ slug `string` (ไม่บังคับ) ส่วนท้ายของที่อยู่ URL ที่ใช้เป็นตัวระบุที่ไม่ซ้ำกันของหน้า

ปลายทาง (Endpoint)

GET /api/v1/landing-pages

ตัวอย่างคำขอ

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

การตอบกลับ

{}

แบบฟอร์มติดต่อบนเว็บไซต์ Performance Hub

รับข้อมูลที่ส่งจากแบบฟอร์มบนเว็บไซต์ Performance Hub (คำขอสาธิต การสอบถามฝ่ายขาย คำสั่งซื้อแบบเข้าถึงก่อน) และส่งอีเมลแจ้งเตือนผ่าน SES

ปลายทาง (Endpoint)

POST /api/v1/performancehub/website-contact

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ขอ OTP ของ Door/Gate Access

ส่งรหัสยืนยันแบบใช้ครั้งเดียวไปยังโทรศัพท์หรืออีเมลที่ระบุ ตอบกลับ 200 เสมอเพื่อป้องกันการไล่หาตัวระบุ จำกัดอัตราต่อตัวระบุและต่อ IP (Redis แบบ sliding window)

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ยืนยัน OTP ของ Door/Gate Access และออกโทเค็น

ยืนยัน OTP ระบุโปรไฟล์บุคคลที่เชื่อมโยงในทุกสถานที่ และส่งกลับ JWT อายุสั้น + โทเค็นรีเฟรชแบบทึบที่หมุนเวียน

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

หมุนเวียนโทเค็นรีเฟรชของ Door/Gate Access

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

เพิกถอนโทเค็นรีเฟรชของ Door/Gate Access

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

เซสชัน Door/Gate Access ปัจจุบัน

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

อัปเดตฟิลด์โปรไฟล์ที่แก้ไขได้

อัปเดต firstName / lastName ในทุกแถว ph-door-access-users ที่ตรงกับตัวระบุใน JWT อีเมลและโทรศัพท์ไม่สามารถเปลี่ยนแปลงได้ที่นี่

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

แสดงรายการสถานที่ของผู้ใช้ Door/Gate Access

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ตั้งค่าสถานที่ที่ผู้ใช้เลือกอยู่ในปัจจุบัน

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

แสดงรายการประตูที่ผู้ใช้สามารถเปิดได้ที่สถานที่

พารามิเตอร์

facilityId `string` (ไม่บังคับ) ตัวระบุสถานที่ (clubID)

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ความพยายามปลดล็อกล่าสุดของผู้ใช้ปัจจุบัน

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}

ปลดล็อกประตูจากแอปมือถือ Door/Gate Access

ตรวจสอบอย่างเข้มงวดที่ฝั่งเซิร์ฟเวอร์ก่อนส่งไปยัง MQTT เซิร์ฟเวอร์เป็นแหล่งข้อมูลที่เชื่อถือได้สำหรับกฎถาวร Access Time Windows แบบเพิ่มเติม การบล็อกประตูที่ระบุชัดเจน โหมดบำรุงรักษา และ Geofence สถานะฝั่งไคลเอ็นต์ใช้เพื่อประสบการณ์ผู้ใช้เท่านั้น

พารามิเตอร์

doorId `string` (จำเป็น) balenaUUID ของตัวควบคุมประตู

ปลายทาง (Endpoint)

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

ตัวอย่างคำขอ

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

การตอบกลับ

{}