Giới thiệu

Đây là API cốt lõi dùng cho các trang web và hệ thống công khai. **Nếu bạn là nhà phát triển bên thứ ba muốn sử dụng API này, vui lòng liên hệ bộ phận hỗ trợ của Performance Hub để đưa IP của bạn vào danh sách cho phép, nếu không bạn sẽ bị giới hạn tốc độ và/hoặc bị chặn khi có quá nhiều yêu cầu từ cùng một nguồn giới thiệu / IP.**

URL cơ sở

https://uapi.gymsystems.co/

Xác thực

Universal API sử dụng xác thực bằng khóa API qua tiêu đề HTTP.

Hãy đưa khóa API của bạn vào tiêu đề X-API-Key trong mỗi yêu cầu.

Hãy xử lý khóa API của bạn cẩn thận, vì chúng cấp toàn quyền truy cập vào tài khoản của bạn! Không bao giờ để lộ các khóa này trong kho mã công khai, ứng dụng phía máy khách hoặc bất kỳ nơi nào chúng có thể bị xâm phạm.

API chỉ chấp nhận kết nối HTTPS bảo mật. Các yêu cầu HTTP thông thường sẽ bị từ chối, cũng như mọi yêu cầu thiếu thông tin xác thực hợp lệ.

Yêu cầu mẫu

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

Biểu mẫu liên hệ chung

API dùng cho các tin nhắn 'liên hệ chung' từ các trang web Example Club và các dịch vụ công khai bên ngoài khác (như training camp, v.v.).

Tham số

organisationId `string` (tùy chọn) ID của tổ chức mà bạn muốn lấy dữ liệu cơ sở. Giá trị này đảm bảo chỉ trả về các cơ sở thuộc cùng một tổ chức. leadForwarding `string` (tùy chọn) Có chuyển tiếp email đến hệ thống quản lý khách hàng tiềm năng nào không (gymsales, gymleads, v.v.)? Lưu ý: đặt thành `onlyForwardIfConfigured` sẽ chuyển tiếp khách hàng tiềm năng đến mọi CRM nhưng không đến email chính của cơ sở...

Nội dung yêu cầu

Nội dung liên hệ chung

Điểm cuối

POST /api/v1/support/contact-submission

Yêu cầu mẫu

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

Phản hồi

{}

Dùng thử miễn phí

Tạo yêu cầu trang đích 'dùng thử miễn phí' cho cơ sở đã chỉ định

Nội dung yêu cầu

Nội dung dùng thử miễn phí

Điểm cuối

POST /api/v1/leads/free-trial

Yêu cầu mẫu

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

Phản hồi

{}

Đặt buổi tập

API dùng cho biểu mẫu 'đặt buổi tập' từ các trang web Example Club.

Nội dung yêu cầu

Nội dung đặt buổi tập

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Thông tin đăng ký quan tâm Training Camp

Theo dõi các lượt đăng ký quan tâm đến Training Camp của người dùng từ các trang web chính. Thông tin này sau đó được dùng để giới thiệu người dùng đến ứng dụng/trang trainingcamp.com và để các cơ sở đăng ký thành viên tham gia training camp.

Nội dung yêu cầu

Nội dung trang

Điểm cuối

POST /api/v1/leads/training-camp

Yêu cầu mẫu

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

Phản hồi

{}

Lấy siêu dữ liệu của một cơ sở hoặc của tất cả cơ sở

API này trả về siêu dữ liệu dùng để hiển thị trang của một cơ sở, hoặc của tất cả cơ sở trong cơ sở dữ liệu.

Tham số

organisationId `string` (tùy chọn) ID của tổ chức mà bạn muốn lấy dữ liệu cơ sở. Giá trị này đảm bảo chỉ trả về các cơ sở thuộc cùng một tổ chức. club `string` (tùy chọn) ID của cơ sở mà bạn muốn lấy... *Lưu ý* Bạn có thể bỏ trống nếu muốn trả về TẤT CẢ cơ sở dưới dạng một đối tượng JSON duy nhất.

Điểm cuối

GET /api/v1/club/data

Yêu cầu mẫu

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

Phản hồi

{}

Lấy siêu dữ liệu của một cơ sở hoặc của tất cả cơ sở

API này trả về siêu dữ liệu dùng để hiển thị trang của một cơ sở, hoặc của tất cả cơ sở trong cơ sở dữ liệu.

Tham số

Điểm cuối

GET /api/v2/club/data

Yêu cầu mẫu

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

Phản hồi

{}

Tìm kiếm cơ sở theo thành phố và vĩ độ/kinh độ

Tìm kiếm các cơ sở lân cận dựa trên vĩ độ, kinh độ và cụm từ tìm kiếm của bạn (như khu vực ngoại ô, thị trấn hoặc thành phố)

Tham số

geogroup `string` (tùy chọn) Trả về danh sách 'được nhóm' gồm các thành phố/bang/quốc gia nơi các cơ sở đặt trụ sở search `string` (tùy chọn) Cụm từ cần tìm. Thông thường đây là: thị trấn, thành phố, khu vực ngoại ô hoặc mã bưu chính limit `string` (tùy chọn) Số kết quả tối đa origin `string` (tùy chọn) Vĩ độ và kinh độ làm điểm gốc cho tìm kiếm. Điều này rất quan trọng khi tìm các thị trấn/khu vực ngoại ô trùng tên nhưng ở các quốc gia/thành phố khác nhau nơi có nhiều cơ sở, ví dụ: `Southbank Example City` hoặc `Southbank Example City 2` organisationId `string` (tùy chọn) ID tổ chức để lọc cơ sở. Giá trị này đảm bảo chỉ trả về các cơ sở thuộc cùng một tổ chức.

Điểm cuối

GET /api/v1/club/geosearch

Yêu cầu mẫu

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

Phản hồi

{}

Liệt kê các đánh giá được ghim của một cơ sở

API này trả về các đánh giá được ghim của cơ sở.

Tham số

club `string` (tùy chọn) ID của cơ sở mà bạn muốn lấy

Điểm cuối

GET /api/v2/club/reviews

Yêu cầu mẫu

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

Phản hồi

{}

Lấy cấu hình của một ứng dụng được đặt tại cơ sở đã chỉ định

Tham số

clubID `string` (tùy chọn) ID của cơ sở mà bạn muốn lấy appID `string` (tùy chọn) ID của ứng dụng mà bạn muốn lấy

Điểm cuối

GET /api/v1/club/apps/config

Yêu cầu mẫu

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

Phản hồi

{}

Vĩ độ và kinh độ dựa trên IP của người dùng

Trả về vĩ độ và kinh độ ước tính của IP người dùng dựa trên GeoIP Database của Maxmind.

Điểm cuối

GET /api/v1/geo/ip

Yêu cầu mẫu

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

Phản hồi

{}

Phân tích một chuỗi địa chỉ và trả về dưới dạng đối tượng.

Chuyển chuỗi địa chỉ thành đối tượng gồm đường phố, thành phố, bang và mã bưu chính.

Nội dung yêu cầu

Nội dung trang

Điểm cuối

POST /api/v1/user/address-parser

Yêu cầu mẫu

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

Phản hồi

{}

Theo dõi các email được gửi trong cơ sở dữ liệu trung tâm.

Theo dõi các email được gửi đến các phần khác nhau của trang web _(ví dụ: API nội bộ, Mailchimp, Hubspot, v.v.)_ và/hoặc API của bên thứ ba trong bảng DynamoDB trung tâm, cho phép phân tích chi tiết hơn và nhắm đến thành viên trong hệ sinh thái Example Club.

Nội dung yêu cầu

Nội dung trang

Điểm cuối

POST /api/v1/analytics/track-email

Yêu cầu mẫu

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

Phản hồi

{}

Gửi dữ liệu đến Graylog

Gửi dữ liệu từ nhiều dịch vụ giao diện đến hệ thống quản lý nhật ký nội bộ (Graylog).

Nội dung yêu cầu

Nội dung trang

Điểm cuối

POST /api/v1/analytics/beacon

Yêu cầu mẫu

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

Phản hồi

{}

Kiểm tra một Myzone Belt ID có được đăng ký với một cơ sở hay không

Trả về phản hồi true hoặc false cho biết một Myzone Belt ID có liên kết với Club ID đã cho hay không.

Tham số

club `string` (tùy chọn) ID của cơ sở cần truy vấn beltid `string` (tùy chọn) ID của Myzone Belt cần tìm

Điểm cuối

GET /api/v1/myzone/belt-registered

Yêu cầu mẫu

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

Phản hồi

{}

Lấy tần suất quẹt thẻ ra vào

Lấy danh sách lượt quẹt thẻ ra vào của thành viên trong một khoảng thời gian

Tham số

start_date `string` (tùy chọn) Ngày bắt đầu của khoảng thời gian dùng để lọc lượt ra vào của thành viên end_date `string` (tùy chọn) Ngày kết thúc của khoảng thời gian dùng để lọc lượt ra vào của thành viên club `string` (tùy chọn) Cơ sở cụ thể mà thành viên đăng ký, dùng để lọc cơ sở nơi thành viên quẹt thẻ email `string` (tùy chọn) Email cụ thể được dùng cho lượt quẹt thẻ ra vào

Điểm cuối

GET /api/v1/members/swipes/frequency

Yêu cầu mẫu

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

Phản hồi

{}

Webhook cho các sự kiện check-in của GymMaster

Điểm cuối

POST /api/v1/webhooks/gymmaster/checkin

Yêu cầu mẫu

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

Phản hồi

{}

Đăng ký/báo ID thiết bị

Lưu UUID, IP và Screen ID (Device ID) của một máy tính Display Screen vào cơ sở dữ liệu, cho phép liên kết thiết bị qua Performance Hub.

Nội dung yêu cầu

Cần gửi một đối tượng JSON đến endpoint này, chứa thông tin về thiết bị như IP và UUID

Điểm cuối

POST /api/v1/devices/dashkiosk/register

Yêu cầu mẫu

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

Phản hồi

{}

Đặt trạng thái của một nút báo động khẩn cấp

Đặt trạng thái `true|false` cho một nút báo động khẩn cấp liên kết với một cơ sở. Lưu ý: bạn chỉ có thể thay đổi trạng thái của nút đã được đăng ký với một cơ sở. Thao tác này không hoạt động với các thiết bị chưa được thiết lập.

Nội dung yêu cầu

Đối tượng JSON trạng thái báo động của nút báo động khẩn cấp

Điểm cuối

POST /api/v1/devices/duress/setAlarmState

Yêu cầu mẫu

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

Phản hồi

{}

Trả về các nút báo động khẩn cấp liên kết với cơ sở

Trả về một mảng các nút báo động khẩn cấp liên kết với một cơ sở để quét cập nhật..

Tham số

clubID `string` (bắt buộc) ID của cơ sở cần truy vấn

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Cập nhật siêu dữ liệu thiết bị

Cập nhật siêu dữ liệu thiết bị cho một UUID. Lưu ý: không cần xác thực để gửi dữ liệu đến hàm này, vì vậy dữ liệu không được chứa bất kỳ thông tin nhạy cảm nào.

Nội dung yêu cầu

Cần gửi một đối tượng JSON đến endpoint này, chứa thông tin về thiết bị như thông tin hệ điều hành, chỉ số Wi-Fi, v.v...

Điểm cuối

POST /api/v1/devices/metadata/beacon

Yêu cầu mẫu

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

Phản hồi

{}

Trả về thông tin về một màn hình dựa trên UUID thiết bị.

Lấy cấu hình của một thiết bị dựa trên UUID của thiết bị, và trả về thông tin như vòng nào được liên kết với thiết bị và nội dung nào cần hiển thị.

Tham số

uuid `string` (bắt buộc) UUID của thiết bị cần lấy cấu hình

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Trả về thông tin cấu hình của một thiết bị dựa trên UUID.

Lấy cấu hình của một thiết bị từ nhiều bảng (Display Screens, thiết bị IoT, thiết bị camera giám sát) bằng UUID của thiết bị, và trả về các chi tiết cấu hình liên quan dưới dạng JSON.

Tham số

uuid `string` (bắt buộc) UUID của thiết bị cần lấy cấu hình

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Đăng ký một thiết bị BLE Beacon

Lưu thông tin thiết bị BLE Beacon vào cơ sở dữ liệu

Nội dung yêu cầu

Dữ liệu thiết bị BLE Beacon

Điểm cuối

POST /api/v1/devices/blebeacon/register

Yêu cầu mẫu

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

Phản hồi

{}

Liệt kê các thiết bị camera giám sát liên kết với ClubID

Liệt kê thông tin tổng quan về các thiết bị camera giám sát liên kết với một ClubID. Lưu ý: API này chỉ trả về thông tin chung/tổng quan như địa chỉ IP cục bộ của thiết bị và trạng thái trực tuyến|ngoại tuyến. Phải dùng Performance Hub API để lấy thông tin chi tiết nâng cao của thiết bị.

Tham số

clubID `string` (bắt buộc) ID của cơ sở cần truy vấn

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Đăng ký một thiết bị camera giám sát

Lưu thông tin thiết bị camera giám sát vào cơ sở dữ liệu

Nội dung yêu cầu

Dữ liệu thiết bị camera giám sát

Điểm cuối

POST /api/v1/devices/cctv/register

Yêu cầu mẫu

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

Phản hồi

{}

Đăng ký một thiết bị AI Edge Processor

Lưu thông tin thiết bị AI Edge Processor vào cơ sở dữ liệu

Nội dung yêu cầu

Dữ liệu thiết bị AI Edge Processor

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Tạo URL đã ký để nhận các bản ghi hình camera giám sát được tải lên

Tạo URL S3 đã ký để máy khách tải trực tiếp bản ghi hình camera giám sát lên S3 để xử lý sau.

Nội dung yêu cầu

Siêu dữ liệu thiết bị

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Thông báo cho S3 rằng quá trình tải lên nhiều phần đã hoàn tất

Thông báo cho S3 rằng máy khách đã hoàn tất quá trình tải lên nhiều phần

Nội dung yêu cầu

Siêu dữ liệu thiết bị

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Gửi lệnh Sonos đến các thiết bị Sonos của cơ sở

Tham số

clubID `string` (bắt buộc) ID của cơ sở cần truy vấn

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Lấy cài đặt Kiểm soát âm thanh của cơ sở

Tham số

clubID `string` (bắt buộc) ID của cơ sở cần truy vấn

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Tạo access token tạm thời

Điểm cuối

POST /api/v1/temporary-access/token

Yêu cầu mẫu

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

Phản hồi

{}

Lấy các mục phát nhạc trực tiếp

Điểm cuối

GET /api/v1/streams

Yêu cầu mẫu

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

Phản hồi

{}

Lấy dữ liệu của mục phát nhạc trực tiếp

Tham số

id `string` (bắt buộc) ID duy nhất xác định một mục phát

Điểm cuối

GET /api/v1/streams/{id}

Yêu cầu mẫu

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

Phản hồi

{}

Lấy các mục câu hỏi thường gặp

Tham số

location `string` (tùy chọn) Vị trí mà bạn muốn mục câu hỏi thường gặp xuất hiện, ví dụ: trang web chính (website_main). categories `string` (tùy chọn) Danh mục của mục câu hỏi thường gặp. status `string` (tùy chọn) Trạng thái của mục

Điểm cuối

GET /api/v1/faqs

Yêu cầu mẫu

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

Phản hồi

{}

Lấy các mục câu hỏi thường gặp

Tham số

category `string` (bắt buộc) Bộ lọc danh mục

Điểm cuối

GET /api/v1/faqs/{category}

Yêu cầu mẫu

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

Phản hồi

{}

Lấy các mục báo chí

Tham số

location `string` (tùy chọn) Vị trí mà bạn muốn mục báo chí xuất hiện, ví dụ: trang web chính (website_main). status `string` (tùy chọn) Trạng thái của mục

Điểm cuối

GET /api/v1/press

Yêu cầu mẫu

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

Phản hồi

{}

Lấy ánh xạ email

Điểm cuối

GET /api/v1/email-mapping

Yêu cầu mẫu

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

Phản hồi

{}

Lấy mã theo dõi tùy chỉnh

Tham số

clubID `string` (bắt buộc) ID cơ sở hoặc vị trí cơ sở, ví dụ: Milton

Điểm cuối

GET /api/v1/customtracking/{clubID}

Yêu cầu mẫu

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

Phản hồi

{}

Lấy các mục trang đích

Tham số

region `string` (tùy chọn) Vùng mà cơ sở thuộc về, ví dụ: AU, NZ, US club `string` (tùy chọn) Club ID, mã định danh duy nhất của cơ sở slug `string` (tùy chọn) Phần cuối của địa chỉ URL, đóng vai trò mã định danh duy nhất của trang

Điểm cuối

GET /api/v1/landing-pages

Yêu cầu mẫu

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

Phản hồi

{}

Biểu mẫu liên hệ trên trang web Performance Hub

Nhận các biểu mẫu được gửi từ trang web Performance Hub (yêu cầu demo, yêu cầu tư vấn bán hàng, đơn đặt hàng truy cập sớm) và gửi email thông báo qua SES.

Điểm cuối

POST /api/v1/performancehub/website-contact

Yêu cầu mẫu

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

Phản hồi

{}

Yêu cầu OTP Door/Gate Access

Gửi mã xác minh dùng một lần đến số điện thoại hoặc email được cung cấp. Luôn phản hồi 200 để ngăn việc dò tìm mã định danh. Giới hạn tốc độ theo từng mã định danh và từng IP (cửa sổ trượt Redis).

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Xác minh OTP Door/Gate Access và cấp token

Xác minh OTP, xác định các hồ sơ cá nhân được liên kết trên tất cả cơ sở, và trả về một JWT ngắn hạn + một refresh token xoay vòng không minh bạch.

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Xoay vòng một refresh token Door/Gate Access

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Thu hồi một refresh token Door/Gate Access

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Phiên Door/Gate Access hiện tại

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Cập nhật các trường hồ sơ có thể chỉnh sửa

Cập nhật firstName / lastName trên mọi dòng ph-door-access-users khớp với mã định danh trong JWT. Email và số điện thoại không thể thay đổi tại đây.

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Liệt kê các cơ sở của người dùng Door/Gate Access

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Đặt cơ sở đang được chọn của người dùng

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Liệt kê các cửa mà người dùng có thể mở tại một cơ sở

Tham số

facilityId `string` (tùy chọn) Mã định danh cơ sở (clubID).

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Các lần thử mở khóa gần đây của người dùng hiện tại

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}

Mở khóa cửa từ ứng dụng di động Door/Gate Access

Kiểm tra nghiêm ngặt ở phía máy chủ trước khi gửi lên MQTT. Máy chủ là nguồn dữ liệu chính xác cho các quy tắc vĩnh viễn, Access Time Windows bổ sung, các lệnh chặn cửa rõ ràng, chế độ bảo trì và geofence. Trạng thái phía máy khách chỉ phục vụ trải nghiệm người dùng.

Tham số

doorId `string` (bắt buộc) balenaUUID của bộ điều khiển cửa.

Điểm cuối

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

Yêu cầu mẫu

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

Phản hồi

{}