परिचय

यह सार्वजनिक साइटों और सिस्टम के लिए उपयोग किया जाने वाला मुख्य API है। **यदि आप एक तृतीय-पक्ष डेवलपर हैं और इस API का उपयोग करना चाहते हैं, तो कृपया अपने IP को whitelist कराने के लिए Performance Hub सहायता से संपर्क करें, अन्यथा एक ही referrer / IP से बहुत अधिक अनुरोध होने पर आपको rate-limit और/या ब्लॉक किया जा सकता है।**

बेस URL

https://uapi.gymsystems.co/

प्रमाणीकरण

Universal API, HTTP हेडर के माध्यम से API कुंजी प्रमाणीकरण का उपयोग करता है।

हर अनुरोध के साथ अपनी API कुंजी X-API-Key हेडर में शामिल करें।

अपनी API कुंजियों को सावधानी से संभालें, ये आपके खाते तक पूरी पहुँच देती हैं! इन कुंजियों को कभी भी सार्वजनिक रिपॉज़िटरी, क्लाइंट-साइड एप्लिकेशन या ऐसी किसी भी जगह उजागर न करें जहाँ इनसे छेड़छाड़ हो सकती है।

API केवल सुरक्षित HTTPS कनेक्शन स्वीकार करता है। सामान्य HTTP अनुरोध अस्वीकार कर दिए जाते हैं, और वे अनुरोध भी जिनमें उचित प्रमाणीकरण क्रेडेंशियल नहीं होते।

उदाहरण अनुरोध

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

सामान्य संपर्क फ़ॉर्म

Example Club वेबसाइटों और अन्य बाहरी सेवाओं (जैसे training camp आदि) से आने वाले 'general contact' संदेशों के लिए उपयोग किया जाने वाला API।

पैरामीटर

organisationId `string` (वैकल्पिक) उस संगठन की ID जिसका क्लब डेटा आप प्राप्त करना चाहते हैं - इसका उपयोग यह सुनिश्चित करने के लिए किया जाता है कि हम केवल उसी संगठन के क्लब लौटाएँ। leadForwarding `string` (वैकल्पिक) क्या हमें ईमेल किसी लीड प्रबंधन सिस्टम (gymsales, gymleads आदि) को आगे भेजने चाहिए? ध्यान दें कि `onlyForwardIfConfigured` सेट करने पर लीड किसी भी CRM को आगे भेजी जाएँगी - लेकिन क्लब के प्राथमिक ईमेल पर नहीं...

अनुरोध बॉडी

सामान्य संपर्क Body

एंडपॉइंट

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

प्रतिक्रिया

{}

निःशुल्क परीक्षण

निर्दिष्ट क्लब के लिए 'free trial' लैंडिंग पेज अनुरोध बनाता है

अनुरोध बॉडी

निःशुल्क परीक्षण Body

एंडपॉइंट

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

प्रतिक्रिया

{}

वर्कआउट बुक करें

Example Club वेबसाइटों के 'book a workout' फ़ॉर्म के लिए उपयोग किया जाने वाला API।

अनुरोध बॉडी

वर्कआउट बुक करें body

एंडपॉइंट

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 में opt-in करने के लिए किया जाता है।

अनुरोध बॉडी

पेज Body

एंडपॉइंट

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 जिसे आप प्राप्त करना चाहते हैं... *NB* यदि आप सभी क्लबों को एक ही JSON Object के रूप में लौटाना चाहते हैं तो इसे छोड़ सकते हैं।

एंडपॉइंट

GET /api/v1/club/data

उदाहरण अनुरोध

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

प्रतिक्रिया

{}

किसी एक क्लब या सभी क्लबों का मेटाडेटा प्राप्त करता है

पैरामीटर

organisationId `string` (वैकल्पिक) उस संगठन की ID जिसका क्लब डेटा आप प्राप्त करना चाहते हैं - इसका उपयोग यह सुनिश्चित करने के लिए किया जाता है कि हम केवल उसी संगठन के क्लब लौटाएँ। club `string` (वैकल्पिक) उस क्लब की ID जिसे आप प्राप्त करना चाहते हैं... *NB* यदि आप सभी क्लबों को एक ही JSON Object के रूप में लौटाना चाहते हैं तो इसे छोड़ सकते हैं।

एंडपॉइंट

GET /api/v2/club/data

उदाहरण अनुरोध

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

प्रतिक्रिया

{}

शहर और lat/lng के अनुसार क्लब खोजें

अपने Latitude, Longitude और खोज शब्दों (जैसे उपनगर, कस्बा या शहर) के आधार पर आस-पास के क्लब खोजें

पैरामीटर

geogroup `string` (वैकल्पिक) उन शहरों/राज्यों/देशों की 'समूहित' सूची लौटाता है जिनमें क्लब स्थित हैं search `string` (वैकल्पिक) खोजा जाने वाला शब्द - आमतौर पर यह इनमें से कोई होगा: कस्बा, शहर, उपनगर या पोस्टकोड limit `string` (वैकल्पिक) परिणामों की अधिकतम संख्या origin `string` (वैकल्पिक) वह Latitude और Longitude जिसके आधार पर खोज करनी है - यह तब अत्यंत महत्वपूर्ण है जब एक ही नाम वाले कस्बे/उपनगर खोजे जा रहे हों, लेकिन वे अलग-अलग देशों/शहरों में हों जहाँ हमारे कई क्लब हैं - उदाहरण के लिए `Southbank Example City` या `Southbank Example City 2` organisationId `string` (वैकल्पिक) क्लब फ़िल्टर करने के लिए संगठन ID - इसका उपयोग यह सुनिश्चित करने के लिए किया जाता है कि हम केवल उसी संगठन के क्लब लौटाएँ।

एंडपॉइंट

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 जिसे आप प्राप्त करना चाहते हैं

एंडपॉइंट

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 जिसे आप प्राप्त करना चाहते हैं

एंडपॉइंट

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 पर आधारित Latitude और Longitude

Maxmind के GeoIP Database के आधार पर किसी उपयोगकर्ता के IP का अनुमानित latitude और longitude लौटाता है।

एंडपॉइंट

GET /api/v1/geo/ip

उदाहरण अनुरोध

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

प्रतिक्रिया

{}

किसी पते की string को पार्स करता है और उसे ऑब्जेक्ट के रूप में लौटाता है।

पते की string को street, city, state और postal code से बने Object में बदलें।

अनुरोध बॉडी

पेज Body

एंडपॉइंट

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 Table में ट्रैक करें, जिससे हम Example Club Ecosystem के सदस्यों का अधिक विस्तृत विश्लेषण और लक्ष्यीकरण कर सकें।

अनुरोध बॉडी

पेज Body

एंडपॉइंट

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 पर beacon करता है

विभिन्न फ़्रंट-एंड सेवाओं से डेटा को हमारे आंतरिक लॉग प्रबंधन सिस्टम (Graylog) पर beacon करता है।

अनुरोध बॉडी

पेज Body

एंडपॉइंट

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 किसी क्लब के साथ पंजीकृत है या नहीं

यदि कोई Myzone Belt ID दिए गए Club ID से संबद्ध है तो true या false प्रतिक्रिया लौटाता है।

पैरामीटर

club `string` (वैकल्पिक) क्वेरी किए जाने वाले क्लब की ID beltid `string` (वैकल्पिक) खोजे जाने वाले Myzone Belt की ID

एंडपॉइंट

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"

प्रतिक्रिया

{}

GymMaster चेक-इन इवेंट के लिए Webhook

एंडपॉइंट

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"

प्रतिक्रिया

{}

डिवाइस ID पंजीकृत/Beacon करें

किसी Display Screen कंप्यूटर का UUID, IP और Screen ID (Device ID) डेटाबेस में संग्रहीत करता है, जिससे Performance Hub के माध्यम से डिवाइस को संबद्ध किया जा सके।

अनुरोध बॉडी

इस एंडपॉइंट पर डिवाइस की जानकारी, जैसे उसका IP और UUID, वाला एक JSON ऑब्जेक्ट पोस्ट किया जाना चाहिए

एंडपॉइंट

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

प्रतिक्रिया

{}

किसी duress बटन की स्थिति सेट करता है

किसी क्लब से संबद्ध duress बटन की स्थिति को `true|false` में से किसी एक पर सेट करता है। ध्यान दें कि आप केवल उसी बटन की स्थिति बदल सकते हैं जो किसी क्लब के साथ पंजीकृत है। यह उन डिवाइस के लिए काम नहीं करेगा जो अभी सेटअप नहीं हुए हैं।

अनुरोध बॉडी

Duress बटन अलार्म स्थिति JSON Object

एंडपॉइंट

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

प्रतिक्रिया

{}

क्लब से संबद्ध Duress बटन लौटाता है

अपडेट के लिए स्कैन करने हेतु किसी क्लब से संबद्ध Duress बटनों का array लौटाता है।

पैरामीटर

clubID `string` (आवश्यक) क्वेरी के लिए क्लब की ID

एंडपॉइंट

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 के लिए डिवाइस मेटाडेटा अपडेट करता है। ध्यान दें कि इस फ़ंक्शन पर डेटा पोस्ट करने के लिए किसी प्रमाणीकरण की आवश्यकता नहीं है, इसलिए डेटा में कोई संवेदनशील जानकारी नहीं होनी चाहिए।

अनुरोध बॉडी

इस एंडपॉइंट पर डिवाइस की जानकारी, जैसे उसकी OS जानकारी, Wifi मीट्रिक आदि, वाला एक JSON ऑब्जेक्ट पोस्ट किया जाना चाहिए...

एंडपॉइंट

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 के आधार पर उसका कॉन्फ़िगरेशन प्राप्त करता है, और यह जानकारी लौटाता है कि डिवाइस से कौन-सा round संबद्ध है और कौन-सी सामग्री दिखाई जानी चाहिए।

पैरामीटर

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 के आधार पर किसी डिवाइस की कॉन्फ़िगरेशन जानकारी लौटाता है।

डिवाइस के UUID का उपयोग करके कई तालिकाओं (Display Screens, IoT Devices, CCTV Devices) से डिवाइस का कॉन्फ़िगरेशन प्राप्त करता है, और संबंधित कॉन्फ़िगरेशन विवरण 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 से संबद्ध CCTV डिवाइस की सूची बनाता है

किसी ClubID से संबद्ध CCTV डिवाइस के उच्च-स्तरीय विवरण की सूची बनाता है - ध्यान दें कि इस API के माध्यम से केवल सामान्य/उच्च-स्तरीय जानकारी लौटाई जाती है, जैसे डिवाइस के स्थानीय IP पते और वे online|offline हैं या नहीं। उन्नत डिवाइस विवरण के लिए Performance Hub API का उपयोग करना आवश्यक है।

पैरामीटर

clubID `string` (आवश्यक) क्वेरी के लिए क्लब की ID

एंडपॉइंट

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"

प्रतिक्रिया

{}

CCTV डिवाइस पंजीकृत करें

CCTV डिवाइस की जानकारी हमारे डेटाबेस में सहेजता है

अनुरोध बॉडी

CCTV डिवाइस डेटा

एंडपॉइंट

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 एज प्रोसेसर डिवाइस पंजीकृत करें

AI एज प्रोसेसर डिवाइस की जानकारी हमारे डेटाबेस में सहेजता है

अनुरोध बॉडी

AI एज प्रोसेसर डिवाइस डेटा

एंडपॉइंट

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

प्रतिक्रिया

{}

CCTV रिकॉर्डिंग अपलोड स्वीकार करने के लिए हस्ताक्षरित URL बनाता है

एक हस्ताक्षरित S3 URL बनाता है ताकि क्लाइंट पोस्ट-प्रोसेसिंग के लिए CCTV रिकॉर्डिंग को सीधे 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 को सूचित करता है कि multipart अपलोड पूरा हो गया है

S3 को सूचित करता है कि क्लाइंट द्वारा multipart अपलोड पूरा कर लिया गया है

अनुरोध बॉडी

डिवाइस मेटाडेटा

एंडपॉइंट

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` (आवश्यक) क्वेरी के लिए क्लब की ID

एंडपॉइंट

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

एंडपॉइंट

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"

प्रतिक्रिया

{}

अस्थायी access token बनाएँ

एंडपॉइंट

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` (आवश्यक) किसी स्ट्रीम आइटम की पहचान करने वाली अद्वितीय id

एंडपॉइंट

GET /api/v1/streams/{id}

उदाहरण अनुरोध

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

प्रतिक्रिया

{}

FAQ आइटम प्राप्त करें

पैरामीटर

location `string` (वैकल्पिक) वह स्थान जहाँ आप FAQ आइटम दिखाना चाहते हैं। उदाहरण: मुख्य वेबसाइट (website_main)। categories `string` (वैकल्पिक) FAQ आइटम की श्रेणियाँ। status `string` (वैकल्पिक) आइटम की स्थिति

एंडपॉइंट

GET /api/v1/faqs

उदाहरण अनुरोध

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

प्रतिक्रिया

{}

FAQ आइटम प्राप्त करें

पैरामीटर

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` (आवश्यक) club id या क्लब का स्थान। उदाहरण: 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` (वैकल्पिक) Club ID, क्लब का अद्वितीय पहचानकर्ता 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 वेबसाइट से फ़ॉर्म सबमिशन (डेमो अनुरोध, बिक्री पूछताछ, early access ऑर्डर) प्राप्त करता है और 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"

प्रतिक्रिया

{}

Door/Gate Access OTP का अनुरोध करें

दिए गए फ़ोन या ईमेल पर एक बार उपयोग होने वाला सत्यापन कोड भेजता है। पहचानकर्ताओं की गणना (enumeration) रोकने के लिए हमेशा 200 लौटाता है। प्रति पहचानकर्ता और प्रति IP rate-limited (Redis sliding window)।

एंडपॉइंट

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"

प्रतिक्रिया

{}

Door/Gate Access OTP सत्यापित करें और tokens जारी करें

OTP सत्यापित करता है, सभी सुविधाओं में जुड़ी व्यक्ति प्रोफ़ाइलों को निर्धारित करता है, और एक अल्पकालिक JWT तथा एक opaque रोटेट होने वाला refresh token लौटाता है।

एंडपॉइंट

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 refresh token रोटेट करें

एंडपॉइंट

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 refresh token रद्द करें

एंडपॉइंट

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"

प्रतिक्रिया

{}

संपादन योग्य प्रोफ़ाइल फ़ील्ड अपडेट करें

JWT पहचानकर्ता से मेल खाने वाली हर ph-door-access-users पंक्ति पर firstName / lastName अपडेट करता है। ईमेल और फ़ोन यहाँ नहीं बदले जा सकते।

एंडपॉइंट

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, स्पष्ट door blocks, maintenance mode और geofence के लिए सर्वर ही सत्य का स्रोत है। क्लाइंट की स्थिति केवल UX के लिए है।

पैरामीटर

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"

प्रतिक्रिया

{}