מבוא

זהו ה-API המרכזי שמשמש אתרים ומערכות הפונים לציבור. **אם אתם מפתחים צד שלישי שרוצים להשתמש ב-API הזה, פנו לתמיכה של Performance Hub כדי שכתובות ה-IP שלכם יתווספו לרשימת ההיתרים; אחרת קצב הבקשות שלכם יוגבל ו/או תיחסמו אם יגיעו יותר מדי בקשות מאותו מפנה / 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 ומשירותים חיצוניים אחרים (כמו מחנה האימונים וכו').

פרמטרים

organisationId `string` (אופציונלי) מזהה הארגון שעבורו ברצונכם לקבל את נתוני המתקנים - משמש כדי להבטיח שיוחזרו רק מתקנים ששייכים לאותו ארגון. leadForwarding `string` (אופציונלי) האם להעביר הודעות דוא"ל למערכת לניהול לידים כלשהי (gymsales, gymleads וכו')? שימו לב שהגדרה ל-`onlyForwardIfConfigured` תעביר לידים לכל CRM - אבל לא לכתובת הדוא"ל הראשית של המתקן...

גוף הבקשה

גוף הבקשה של יצירת קשר כללית

נקודת קצה

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

תגובה

{}

תקופת ניסיון חינם

יוצר בקשה לדף נחיתה של 'תקופת ניסיון חינם' עבור המתקן שצוין

גוף הבקשה

גוף הבקשה של תקופת ניסיון חינם

נקודת קצה

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.

גוף הבקשה

גוף הבקשה של הזמנת אימון

נקודת קצה

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, וכדי שמתקנים יוכלו לרשום את החבר למחנה האימונים.

גוף הבקשה

גוף הדף

נקודת קצה

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` (אופציונלי) מזהה הארגון שעבורו ברצונכם לקבל את נתוני המתקנים - משמש כדי להבטיח שיוחזרו רק מתקנים ששייכים לאותו ארגון. club `string` (אופציונלי) מזהה המתקן שברצונכם לקבל... *שימו לב* ניתן להשמיט אותו אם ברצונכם להחזיר את כל המתקנים כאובייקט JSON יחיד.

נקודת קצה

GET /api/v1/club/data

בקשה לדוגמה

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

תגובה

{}

מקבל את המטא-נתונים של מתקן בודד או של כל המתקנים

ה-API הזה מחזיר את המטא-נתונים שמשמשים להצגת דף מתקן עבור מתקן בודד, או את כל המתקנים במסד הנתונים.

פרמטרים

נקודת קצה

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` (אופציונלי) מזהה הארגון לסינון המתקנים - משמש כדי להבטיח שיוחזרו רק מתקנים ששייכים לאותו ארגון.

נקודת קצה

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` (אופציונלי) מזהה המתקן שברצונכם לקבל

נקודת קצה

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` (אופציונלי) מזהה המתקן שברצונכם לקבל appID `string` (אופציונלי) מזהה האפליקציה שברצונכם לקבל

נקודת קצה

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.

נקודת קצה

GET /api/v1/geo/ip

בקשה לדוגמה

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

תגובה

{}

מנתח מחרוזת כתובת ומחזיר אותה כאובייקט.

המרת מחרוזת הכתובת לאובייקט שמורכב מרחוב, עיר, מדינה או מחוז ומיקוד.

גוף הבקשה

גוף הדף

נקודת קצה

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.

גוף הבקשה

גוף הדף

נקודת קצה

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).

גוף הבקשה

גוף הדף

נקודת קצה

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 `string` (אופציונלי) מזהה המתקן לשאילתה beltid `string` (אופציונלי) המזהה של חגורת Myzone לחיפוש

נקודת קצה

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` (אופציונלי) כתובת הדוא"ל שבה נעשה שימוש בהחתמת הביקור

נקודת קצה

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

נקודת קצה

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"

תגובה

{}

רישום ודיווח של מזהה מכשיר

שומר במסד הנתונים את ה-UUID, כתובת ה-IP ומזהה המסך (מזהה המכשיר) של מחשב Display Screens, כדי לאפשר את שיוך המכשיר דרך Performance Hub.

גוף הבקשה

יש לשלוח לנקודת הקצה הזו אובייקט JSON שמכיל מידע על המכשיר, כמו כתובת ה-IP וה-UUID שלו

נקודת קצה

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 של מצב האזעקה של לחצן המצוקה

נקודת קצה

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` (חובה) מזהה המתקן לשאילתה

נקודת קצה

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 וכו'...

נקודת קצה

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 של המכשיר שעבורו מאוחזרת התצורה

נקודת קצה

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 של המכשיר שעבורו יש לאחזר את התצורה

נקודת קצה

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

נקודת קצה

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 המקומיות של המכשירים והאם הם מקוונים|לא מקוונים. לפרטים מתקדמים על המכשירים יש להשתמש ב-API של Performance Hub.

פרמטרים

clubID `string` (חובה) מזהה המתקן לשאילתה

נקודת קצה

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"

תגובה

{}

רישום מכשיר טלוויזיה במעגל סגור

שומר את פרטי מכשיר הטלוויזיה במעגל סגור במסד הנתונים שלנו

גוף הבקשה

נתוני מכשיר טלוויזיה במעגל סגור

נקודת קצה

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

נקודת קצה

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 לעיבוד נוסף.

גוף הבקשה

המטא-נתונים של המכשיר

נקודת קצה

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 שהלקוח השלים את ההעלאה מרובת החלקים

גוף הבקשה

המטא-נתונים של המכשיר

נקודת קצה

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 של המתקן

פרמטרים

clubID `string` (חובה) מזהה המתקן לשאילתה

נקודת קצה

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` (חובה) מזהה המתקן לשאילתה

נקודת קצה

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"

תגובה

{}

יצירת אסימון גישה זמני

נקודת קצה

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"

תגובה

{}

אחזור פריטי שידור מוזיקה חי

נקודת קצה

GET /api/v1/streams

בקשה לדוגמה

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

תגובה

{}

אחזור הנתונים של פריט שידור מוזיקה חי

פרמטרים

id `string` (חובה) מזהה ייחודי של פריט שידור

נקודת קצה

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` (אופציונלי) הסטטוס של הפריט

נקודת קצה

GET /api/v1/faqs

בקשה לדוגמה

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

תגובה

{}

אחזור פריטי שאלות נפוצות

פרמטרים

category `string` (חובה) מסנן קטגוריות

נקודת קצה

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` (אופציונלי) הסטטוס של הפריט

נקודת קצה

GET /api/v1/press

בקשה לדוגמה

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

תגובה

{}

אחזור מיפוי כתובות דוא"ל

נקודת קצה

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` (חובה) מזהה המתקן או המיקום של המתקן, לדוגמה: Milton

נקודת קצה

GET /api/v1/customtracking/{clubID}

בקשה לדוגמה

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

תגובה

{}

אחזור פריטי דפי נחיתה

פרמטרים

region `string` (אופציונלי) האזור שאליו שייך המתקן, לדוגמה: AU, NZ, US club `string` (אופציונלי) מזהה המתקן, המזהה הייחודי של המתקן slug `string` (אופציונלי) החלק האחרון של כתובת ה-URL, שמשמש כמזהה ייחודי של הדף

נקודת קצה

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.

נקודת קצה

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).

נקודת קצה

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 קצר מועד + אסימון רענון אטום מתחלף.

נקודת קצה

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

נקודת קצה

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

נקודת קצה

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

נקודת קצה

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. לא ניתן לשנות כאן את הדוא"ל ואת הטלפון.

נקודת קצה

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

נקודת קצה

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"

תגובה

{}

הגדרת המתקן שהמשתמש בחר כרגע

נקודת קצה

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).

נקודת קצה

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"

תגובה

{}

ניסיונות ביטול הנעילה האחרונים של המשתמש הנוכחי

נקודת קצה

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 של בקר הדלת.

נקודת קצה

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"

תגובה

{}