Giriş

Bu, herkese açık siteler ve sistemler için kullanılan temel API'dir. **Bu API'yi kullanmak isteyen bir üçüncü taraf geliştiriciyseniz, IP adreslerinizin izin listesine eklenmesi için lütfen Performance Hub desteğiyle iletişime geçin; aksi takdirde aynı yönlendiriciden / IP'den çok fazla istek gelirse hız sınırlamasına tabi tutulursunuz ve/veya engellenirsiniz.**

Temel URL

https://uapi.gymsystems.co/

Kimlik doğrulama

Universal API, HTTP üst bilgileri aracılığıyla API anahtarı kimlik doğrulaması kullanır.

API anahtarınızı her istekte X-API-Key üst bilgisine ekleyin.

API anahtarlarınızı dikkatle kullanın; hesabınıza tam erişim sağlarlar! Bu anahtarları hiçbir zaman herkese açık depolarda, istemci tarafı uygulamalarda veya ele geçirilebilecekleri herhangi bir yerde açığa çıkarmayın.

API yalnızca güvenli HTTPS bağlantılarını kabul eder. Düz HTTP istekleri ve uygun kimlik doğrulama bilgileri eksik olan tüm istekler reddedilir.

Örnek İstek

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

Genel İletişim Formu

Example Club web sitelerinden ve diğer dışa dönük hizmetlerden (eğitim kampı vb.) gelen 'genel iletişim' mesajları için kullanılan API.

Parametreler

organisationId `string` (isteğe bağlı) Tesis verilerini almak istediğiniz organizasyonun kimliği; yalnızca aynı organizasyona ait tesislerin döndürülmesini sağlamak için kullanılır. leadForwarding `string` (isteğe bağlı) E-postalar herhangi bir potansiyel müşteri yönetim sistemine (gymsales, gymleads vb.) iletilsin mi? Not: `onlyForwardIfConfigured` olarak ayarlamak potansiyel müşterileri herhangi bir CRM'e iletir, ancak tesisin birincil e-posta adresine iletmez.

İstek Gövdesi

Genel İletişim Gövdesi

Uç nokta

POST /api/v1/support/contact-submission

Örnek İstek

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

Yanıt

{}

Ücretsiz Deneme

Belirtilen tesis için bir 'ücretsiz deneme' açılış sayfası isteği oluşturur

İstek Gövdesi

Ücretsiz Deneme Gövdesi

Uç nokta

POST /api/v1/leads/free-trial

Örnek İstek

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

Yanıt

{}

Antrenman Rezervasyonu

Example Club web sitelerindeki 'book a workout' formu için kullanılan API.

İstek Gövdesi

Antrenman Rezervasyonu gövdesi

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Training Camp Potansiyel Müşteri Gönderimleri

Ana web sitelerimizden kullanıcının Training Camp'e ilgisini kaydetmek için yapılan gönderimleri izler. Bu bilgiler daha sonra kullanıcıyı trainingcamp.com uygulamasına/sitesine yönlendirmek ve tesislerin üyeyi eğitim kampına dahil edebilmesi için kullanılır.

İstek Gövdesi

Sayfa Gövdesi

Uç nokta

POST /api/v1/leads/training-camp

Örnek İstek

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

Yanıt

{}

Tek bir tesisin veya tüm tesislerin meta verilerini alır

Bu API, tek bir tesisin sayfasını oluşturmak için kullanılan tesis meta verilerini veya veritabanındaki tüm tesisleri döndürür.

Parametreler

organisationId `string` (isteğe bağlı) Tesis verilerini almak istediğiniz organizasyonun kimliği; yalnızca aynı organizasyona ait tesislerin döndürülmesini sağlamak için kullanılır. club `string` (isteğe bağlı) Almak istediğiniz tesisin kimliği. *NB* TÜM tesisleri tek bir JSON nesnesi olarak döndürmek istiyorsanız bunu atlayabilirsiniz.

Uç nokta

GET /api/v1/club/data

Örnek İstek

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

Yanıt

{}

Tek bir tesisin veya tüm tesislerin meta verilerini alır

Bu API, tek bir tesisin sayfasını oluşturmak için kullanılan tesis meta verilerini veya veritabanındaki tüm tesisleri döndürür.

Parametreler

organisationId `string` (isteğe bağlı) Tesis verilerini almak istediğiniz organizasyonun kimliği; yalnızca aynı organizasyona ait tesislerin döndürülmesini sağlamak için kullanılır. club `string` (isteğe bağlı) Almak istediğiniz tesisin kimliği. *NB* TÜM tesisleri tek bir JSON nesnesi olarak döndürmek istiyorsanız bunu atlayabilirsiniz.

Uç nokta

GET /api/v2/club/data

Örnek İstek

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

Yanıt

{}

Şehre ve enlem/boylama göre tesis arama

Enleminize, boylamınıza ve arama terimlerinize (semt, kasaba veya şehir gibi) göre yakındaki tesisleri arar

Parametreler

geogroup `string` (isteğe bağlı) Tesislerin bulunduğu şehirlerin/eyaletlerin/ülkelerin 'gruplanmış' bir listesini döndürür search `string` (isteğe bağlı) Aranacak terim; genellikle bir kasaba, şehir, semt veya posta kodudur limit `string` (isteğe bağlı) Sınırlanacak sonuç sayısı origin `string` (isteğe bağlı) Aramanın temel alınacağı enlem ve boylam. Aynı ada sahip ancak birden fazla tesisimizin bulunduğu farklı ülkelerde/şehirlerde yer alan kasabaları/semtleri ararken bu kritik öneme sahiptir; ör. `Southbank Example City` veya `Southbank Example City 2` organisationId `string` (isteğe bağlı) Tesisleri filtrelemek için organizasyon kimliği; yalnızca aynı organizasyona ait tesislerin döndürülmesini sağlamak için kullanılır.

Uç nokta

GET /api/v1/club/geosearch

Örnek İstek

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

Yanıt

{}

Tek bir tesisin sabitlenmiş değerlendirmelerini listeler

Bu API, tesisin sabitlenmiş değerlendirmelerini döndürür.

Parametreler

club `string` (isteğe bağlı) Almak istediğiniz tesisin kimliği

Uç nokta

GET /api/v2/club/reviews

Örnek İstek

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

Yanıt

{}

Belirtilen tesiste ayarlanmış bir uygulamanın yapılandırmasını alır

Parametreler

clubID `string` (isteğe bağlı) Almak istediğiniz tesisin kimliği appID `string` (isteğe bağlı) Almak istediğiniz uygulamanın kimliği

Uç nokta

GET /api/v1/club/apps/config

Örnek İstek

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

Yanıt

{}

Kullanıcının IP adresine göre enlem ve boylam

Maxmind'ın GeoIP veritabanına göre bir kullanıcının IP adresinin tahmini enlem ve boylamını döndürür.

Uç nokta

GET /api/v1/geo/ip

Örnek İstek

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

Yanıt

{}

Bir adres dizesini ayrıştırır ve nesne olarak döndürür.

Adres dizesini sokak, şehir, eyalet ve posta kodundan oluşan bir nesneye dönüştürür.

İstek Gövdesi

Sayfa Gövdesi

Uç nokta

POST /api/v1/user/address-parser

Örnek İstek

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

Yanıt

{}

Gönderilen e-postaları merkezi veritabanımızda izler.

Web sitemizin çeşitli bölümlerine _(ör. dahili API'ler, Mailchimp, Hubspot vb.)_ ve/veya üçüncü taraf API'lere gönderilen e-postaları merkezi DynamoDB tablomuzda izler; böylece Example Club ekosistemindeki üyelerin daha ayrıntılı analizini ve hedeflenmesini sağlar.

İstek Gövdesi

Sayfa Gövdesi

Uç nokta

POST /api/v1/analytics/track-email

Örnek İstek

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

Yanıt

{}

Verileri Graylog'a gönderir

Çeşitli ön yüz hizmetlerinden gelen verileri dahili kayıt yönetim sistemimize (Graylog) gönderir.

İstek Gövdesi

Sayfa Gövdesi

Uç nokta

POST /api/v1/analytics/beacon

Örnek İstek

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

Yanıt

{}

Bir Myzone Belt ID'nin bir tesise kayıtlı olup olmadığını denetler

Bir Myzone Belt ID'nin belirtilen tesis kimliğiyle ilişkili olup olmadığına göre true veya false yanıtı döndürür.

Parametreler

club `string` (isteğe bağlı) Sorgulanacak tesisin kimliği beltid `string` (isteğe bağlı) Aranacak Myzone Belt kimliği

Uç nokta

GET /api/v1/myzone/belt-registered

Örnek İstek

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

Yanıt

{}

Ziyaret Geçiş Sıklığını Alma

Belirli bir dönemde üyelerin yaptığı ziyaret geçişlerinin listesini alır

Parametreler

start_date `string` (isteğe bağlı) Üye ziyaretlerini filtrelemek için kullanılan dönem başlangıç tarihi end_date `string` (isteğe bağlı) Üye ziyaretlerini filtrelemek için kullanılan dönem bitiş tarihi club `string` (isteğe bağlı) Üyenin hangi tesiste geçiş yaptığını filtrelemek için üyenin abone olduğu tesis email `string` (isteğe bağlı) Ziyaret geçişi için kullanılan e-posta adresi

Uç nokta

GET /api/v1/members/swipes/frequency

Örnek İstek

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

Yanıt

{}

GymMaster giriş olayları için webhook

Uç nokta

POST /api/v1/webhooks/gymmaster/checkin

Örnek İstek

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

Yanıt

{}

Cihaz Kimliğini Kaydetme/Bildirme

Bir Display Screens bilgisayarının UUID, IP ve Screen ID (Device ID) değerlerini veritabanında saklar; böylece cihaz Performance Hub üzerinden ilişkilendirilebilir.

İstek Gövdesi

Bu uç noktaya, cihazın IP ve UUID gibi bilgilerini içeren bir JSON nesnesi gönderilmelidir

Uç nokta

POST /api/v1/devices/dashkiosk/register

Örnek İstek

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

Yanıt

{}

Bir Duress düğmesinin durumunu ayarlar

Bir tesisle ilişkili Duress düğmesinin durumunu `true|false` olarak ayarlar. Not: Yalnızca bir tesise kayıtlı bir düğmenin durumunu değiştirebilirsiniz. Bu, henüz kurulmamış cihazlarda çalışmaz.

İstek Gövdesi

Duress Düğmesi Alarm Durumu JSON Nesnesi

Uç nokta

POST /api/v1/devices/duress/setAlarmState

Örnek İstek

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

Yanıt

{}

Tesisle ilişkili Duress düğmelerini döndürür

Güncellemeleri taramak için bir tesisle ilişkili Duress düğmelerinin dizisini döndürür.

Parametreler

clubID `string` (zorunlu) Sorgulanacak tesisin kimliği

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Cihaz Meta Verilerini Günceller

Bir UUID için cihaz meta verilerini günceller. Not: Bu işleve veri göndermek için kimlik doğrulaması gerekmez, bu nedenle veriler hassas bilgi içermemelidir.

İstek Gövdesi

Bu uç noktaya, cihazın işletim sistemi bilgileri, Wi-Fi ölçümleri vb. bilgilerini içeren bir JSON nesnesi gönderilmelidir.

Uç nokta

POST /api/v1/devices/metadata/beacon

Örnek İstek

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

Yanıt

{}

Cihaz UUID'sine göre bir ekran hakkında bilgi döndürür.

Cihazın UUID'sine göre bir cihazın yapılandırmasını alır ve cihazla hangi turun ilişkili olduğu ve hangi içeriğin görüntüleneceği gibi bilgileri döndürür.

Parametreler

uuid `string` (zorunlu) Yapılandırmayı getiren cihazın UUID'si

Uç nokta

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

Örnek İstek

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

Yanıt

{}

UUID'ye göre bir cihazın yapılandırma bilgilerini döndürür.

Cihazın UUID'sini kullanarak bir cihazın yapılandırmasını birden fazla tablodan (Display Screens, IoT cihazları, güvenlik kamerası cihazları) getirir ve ilgili yapılandırma ayrıntılarını JSON olarak döndürür.

Parametreler

uuid `string` (zorunlu) Yapılandırması getirilecek cihazın UUID'si

Uç nokta

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

Örnek İstek

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

Yanıt

{}

BLE Beacon cihazı kaydetme

BLE Beacon cihaz bilgilerini veritabanımıza kaydeder

İstek Gövdesi

BLE Beacon Cihaz Verileri

Uç nokta

POST /api/v1/devices/blebeacon/register

Örnek İstek

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

Yanıt

{}

ClubID ile ilişkili güvenlik kamerası cihazlarını listeler

Bir ClubID ile ilişkili güvenlik kamerası cihazlarının üst düzey ayrıntılarını listeler. Not: Bu API yalnızca cihazların yerel IP adresleri ve çevrimiçi|çevrimdışı olup olmadıkları gibi genel/üst düzey bilgileri döndürür. Gelişmiş cihaz ayrıntıları için Performance Hub API kullanılmalıdır.

Parametreler

clubID `string` (zorunlu) Sorgulanacak tesisin kimliği

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Güvenlik kamerası cihazı kaydetme

Güvenlik kamerası cihaz bilgilerini veritabanımıza kaydeder

İstek Gövdesi

Güvenlik Kamerası Cihaz Verileri

Uç nokta

POST /api/v1/devices/cctv/register

Örnek İstek

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

Yanıt

{}

AI Edge Processor cihazı kaydetme

AI Edge Processor cihaz bilgilerini veritabanımıza kaydeder

İstek Gövdesi

AI Edge Processor Cihaz Verileri

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Güvenlik kamerası kayıt yüklemelerini kabul etmek için imzalı bir URL oluşturur

İstemcinin bir güvenlik kamerası kaydını sonradan işlenmek üzere doğrudan S3'e yükleyebilmesi için imzalı bir S3 URL'si oluşturur.

İstek Gövdesi

Cihaz meta verileri

Uç nokta

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

Örnek İstek

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

Yanıt

{}

S3'e çok parçalı yüklemenin tamamlandığını bildirir

S3'e çok parçalı yüklemenin istemci tarafından tamamlandığını bildirir

İstek Gövdesi

Cihaz meta verileri

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Tesisin Sonos cihazlarına Sonos komutu gönderme

Parametreler

clubID `string` (zorunlu) Sorgulanacak tesisin kimliği

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Tesisin Ses Kontrolü ayarlarını alma

Parametreler

clubID `string` (zorunlu) Sorgulanacak tesisin kimliği

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Geçici erişim belirteci oluşturma

Uç nokta

POST /api/v1/temporary-access/token

Örnek İstek

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

Yanıt

{}

Müzik Canlı Yayın Öğelerini Alma

Uç nokta

GET /api/v1/streams

Örnek İstek

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

Yanıt

{}

Müzik Canlı Yayın Öğesi Verilerini Alma

Parametreler

id `string` (zorunlu) Bir yayın öğesini tanımlayan benzersiz kimlik

Uç nokta

GET /api/v1/streams/{id}

Örnek İstek

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

Yanıt

{}

SSS Öğelerini Alma

Parametreler

location `string` (isteğe bağlı) SSS öğesinin görünmesini istediğiniz konum. ör.: ana web sitesi (website_main). categories `string` (isteğe bağlı) SSS öğesinin kategorileri. status `string` (isteğe bağlı) Öğenin durumu

Uç nokta

GET /api/v1/faqs

Örnek İstek

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

Yanıt

{}

SSS Öğelerini Alma

Parametreler

category `string` (zorunlu) Kategori filtresi

Uç nokta

GET /api/v1/faqs/{category}

Örnek İstek

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

Yanıt

{}

Basın Öğelerini Alma

Parametreler

location `string` (isteğe bağlı) Basın öğesinin görünmesini istediğiniz konum. ör.: ana web sitesi (website_main). status `string` (isteğe bağlı) Öğenin durumu

Uç nokta

GET /api/v1/press

Örnek İstek

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

Yanıt

{}

E-posta Eşlemesini Alma

Uç nokta

GET /api/v1/email-mapping

Örnek İstek

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

Yanıt

{}

Özel İzleme Kodlarını Alma

Parametreler

clubID `string` (zorunlu) Tesis kimliği veya tesis konumu. ör.: Milton

Uç nokta

GET /api/v1/customtracking/{clubID}

Örnek İstek

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

Yanıt

{}

Açılış Sayfası Öğelerini Alma

Parametreler

region `string` (isteğe bağlı) Tesisin ait olduğu bölge. ör.: AU, NZ, US club `string` (isteğe bağlı) Tesis kimliği, tesisin benzersiz tanımlayıcısı slug `string` (isteğe bağlı) URL adresinin, sayfanın benzersiz tanımlayıcısı olarak işlev gören son bölümü

Uç nokta

GET /api/v1/landing-pages

Örnek İstek

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

Yanıt

{}

Performance Hub Web Sitesi İletişim Formu

Performance Hub web sitesinden gelen form gönderimlerini (demo talepleri, satış soruları, erken erişim siparişleri) alır ve SES aracılığıyla bildirim e-postaları gönderir.

Uç nokta

POST /api/v1/performancehub/website-contact

Örnek İstek

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

Yanıt

{}

Door/Gate Access OTP'si isteme

Verilen telefon numarasına veya e-posta adresine tek kullanımlık bir doğrulama kodu gönderir. Tanımlayıcı numaralandırmasını önlemek için her zaman 200 döndürür. Tanımlayıcı ve IP başına hız sınırlaması uygulanır (Redis kayan pencere).

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Door/Gate Access OTP'sini doğrulama ve belirteç verme

OTP'yi doğrular, tüm tesislerdeki bağlantılı kişi profillerini çözümler ve kısa ömürlü bir JWT + opak, dönüşümlü bir yenileme belirteci döndürür.

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Door/Gate Access yenileme belirtecini yenileme

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Door/Gate Access yenileme belirtecini iptal etme

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Geçerli Door/Gate Access oturumu

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Düzenlenebilir profil alanlarını güncelleme

JWT tanımlayıcısıyla eşleşen her ph-door-access-users satırındaki firstName / lastName değerlerini günceller. E-posta ve telefon burada değiştirilemez.

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Door/Gate Access kullanıcısının tesislerini listeleme

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Kullanıcının şu anda seçili tesisini ayarlama

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Kullanıcının bir tesiste açabileceği kapıları listeleme

Parametreler

facilityId `string` (isteğe bağlı) Tesis tanımlayıcısı (clubID).

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Geçerli kullanıcının son kilit açma denemeleri

Uç nokta

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

Örnek İstek

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

Yanıt

{}

Door/Gate Access mobil uygulamasından kapı kilidini açma

MQTT'ye yayımlamadan önce sunucu tarafında sıkı denetimler yapılır. Kalıcı kurallar, ek Access Time Windows, açık kapı engellemeleri, bakım modu ve geofence için doğru kaynak sunucudur. İstemci durumu yalnızca kullanıcı deneyimi içindir.

Parametreler

doorId `string` (zorunlu) Kapı denetleyicisinin balenaUUID değeri.

Uç nokta

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

Örnek İstek

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

Yanıt

{}