소개

Performance Hub API에 오신 것을 환영합니다. 이 API는 클럽 데이터와, 클럽 및 클럽의 외부 시스템과 통합되는 주요 시스템을 관리하며, 공개적으로 사용할 수 있는 API가 아닙니다. 이 API가 지원하는 다양한 Performance Hub 시스템의 사용에 관한 자세한 내용은 [Performance Hub 문서](https://docs.performancehub.co)에서 필요한 시스템의 개별 항목을 참조하십시오.

기본 URL

https://portal.hub.gymsystems.co

인증

인증 세부 정보는 통합이 승인되면 제공됩니다.

기기가 보고하는 "에이전트 턴 완료" 이벤트(웹 푸시 트리거)

웹 UI에서 시작한 에이전트 실행이 끝났고 그 실행 시간이 기기의 알림 임계값보다 길었을 때, 페어링된 AI 에이전트 기기의 사이드카가 호출합니다(브라우저는 호출하지 않습니다). 수명이 짧은 기기별 HS256 JWT(aud 'events')로 인증합니다. 기기+세션+시작 단위로 중복이 제거되고 기기별로 속도가 제한된 후, 대화로 연결되는 딥 링크와 함께 실행을 시작한 사용자의 HTML5 푸시 구독으로 전달됩니다.

요청 본문

엔드포인트

POST /ai/events/agent-turn-complete

요청 예시

curl -X POST https://portal.hub.gymsystems.co/ai/events/agent-turn-complete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트가 시작하는 푸시 알림(ph-notify 스킬)

페어링된 AI 에이전트 기기의 사이드카가 기기 내 에이전트(ph-notify 스킬)를 대신해 호출하며, 사용자의 브라우저와 모바일 기기에 임의의 알림을 푸시합니다. 수명이 짧은 기기별 HS256 JWT(aud 'events')로 인증합니다. 대상 사용자는 해당 기기에 대한 액세스 권한(에이전트별 액세스 정책)이 있어야 하며, 생략하면 알림은 기기 소유자에게 전송됩니다. 턴 완료 이벤트와는 별도로 기기별로 속도가 제한됩니다.

요청 본문

엔드포인트

POST /ai/events/agent-notify

요청 예시

curl -X POST https://portal.hub.gymsystems.co/ai/events/agent-notify \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

알림 이미지 업로드(ph-notify 스킬)

페어링된 기기(aud 'events' JWT)에서 원시 이미지 본문을 받아 추측할 수 없는 UUID 키로 공개 notify-media 버킷에 저장합니다. 객체는 7일 후 자동으로 삭제됩니다(S3 수명 주기). /ai/events/agent-notify에서 `imageUrl`로 사용할 공개 https URL을 반환합니다. 최대 5 MB이며 png/jpeg/gif/webp만 허용됩니다.

요청 본문

엔드포인트

POST /ai/media/notify-image

요청 예시

curl -X POST https://portal.hub.gymsystems.co/ai/media/notify-image \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Connected Apps(외부 SaaS 도구)용 기기 MCP 릴레이

페어링된 AI 에이전트 기기용 Streamable-HTTP MCP 엔드포인트입니다(기기 사이드카의 :8790 리스너에 있는 "connected_apps" MCP 서버). 기기별 단기 HS256 JWT(aud 'mcp', /mcp와 동일한 자격 증명)로 인증하며, 에이전트의 Connected Apps 활성화 플래그로 제한됩니다(연결은 시설별이 아니라 에이전트 기기별로 관리됨). 요청은 서버 측에서 세션 헤더가 주입된 상태로 에이전트 자체의 업스트림 도구 플랫폼 세션 MCP 서버로 스트리밍되며, 업스트림 자격 증명은 기기에 전달되지 않습니다. 도구 이름과 공급업체 브랜딩은 전송 중에 양방향으로 화이트 라벨 처리됩니다. 업스트림에서 401/410(세션 만료)이 반환되면 세션을 한 번 다시 만들고 재시도합니다.

엔드포인트

POST /mcp/apps

요청 예시

curl -X POST https://portal.hub.gymsystems.co/mcp/apps \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

API 감사 로그 검색(IAM 및 관리 모듈 액세스)

고급 필터링 기능으로 API 액세스 로그를 검색하고 필터링합니다. 사용자는 액세스 권한이 있는 조직의 로그만 볼 수 있습니다.

매개변수

organisationId `string` (선택) ACL 확인용 조직 ID(필수)

요청 본문

엔드포인트

POST /api/admin/audit-logs/search

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/admin/audit-logs/search \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Redis에서 캐시된 감사 로그 통계 가져오기(IAM 및 관리 모듈 액세스)

대시보드를 즉시 로드할 수 있도록 Redis 캐시에서 집계된 통계를 조회합니다

매개변수

timeWindow `string` (선택) 통계 기간(기본값 12h)

엔드포인트

GET /api/admin/audit-logs/statistics-cached

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/statistics-cached \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

감사 로그 통계 가져오기(IAM 및 관리 모듈 액세스)

대시보드용 집계 통계를 조회합니다. 범위는 사용자의 조직으로 한정됩니다.

매개변수

startTime `number` (선택) 시작 시간(Unix 타임스탬프), 기본값은 24시간 전 endTime `number` (선택) 종료 시간(Unix 타임스탬프), 기본값은 현재

엔드포인트

GET /api/admin/audit-logs/statistics

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/statistics \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

감사 로그 시계열 데이터 가져오기(IAM 및 관리 모듈 액세스)

요청 타임라인 시각화를 위해 구간별로 나눈 시계열 데이터를 조회합니다

매개변수

timeWindow `string` (선택) 시계열 데이터 기간: - 1h: 최근 1시간(10분 단위) - 12h: 최근 12시간(10분 단위) - 24h: 최근 24시간(10분 단위) - 7d: 최근 7일(1시간 단위) - 14d: 최근 14일(1시간 단위)

엔드포인트

GET /api/admin/audit-logs/timeseries

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/timeseries \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자가 감사 로그에 액세스할 수 있는 조직 가져오기(IAM 및 관리 모듈 액세스)

현재 사용자가 감사 로그를 볼 수 있는 조직 목록을 반환합니다

엔드포인트

GET /api/admin/audit-logs/user-organisations

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/user-organisations \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

새 클럽을 생성하는 최초 호출입니다. '템플릿' 클럽 객체만 생성된다는 점에 유의하십시오. 이후 운영 시간, 위치, 소셜 URL 등의 데이터로 클럽을 업데이트하려면 두 번째 API 요청이 필요합니다.

매개변수

body `string` (필수) 시스템에 추가할 새 클럽의 JSON 객체입니다.

엔드포인트

POST /api/admin/clubs/addclub

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/admin/clubs/addclub \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시스템에 새 사용자를 추가합니다

매개변수

body `string` (필수) 추가/업데이트할 사용자 데이터의 JSON 객체입니다.

엔드포인트

POST /api/users

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/users \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

백오피스 시스템/API에 액세스할 수 있는 모든 사용자(Google Apps 계정)를 나열합니다

엔드포인트

GET /api/admin/users/listusers

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/admin/users/listusers \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자의 MCP 키를 나열합니다(마스킹됨). 사용자는 자신의 키를 나열할 수 있습니다.

매개변수

userId `string` (필수)

엔드포인트

GET /api/users/{userId}/mcp-keys

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/users/{userId}/mcp-keys \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자의 새 MCP API 키를 생성합니다. 사용자는 자신의 키를 생성할 수 있습니다.

매개변수

userId `string` (필수) body `object` (선택)

엔드포인트

POST /api/users/{userId}/mcp-keys

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/users/{userId}/mcp-keys \
  -H "x-api-key: YOUR_API_KEY"

MCP API 키를 해지/제거합니다. 사용자는 자신의 키를 삭제할 수 있습니다.

매개변수

userId `string` (필수) keyId `string` (필수)

엔드포인트

DELETE /api/users/{userId}/mcp-keys/{keyId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/users/{userId}/mcp-keys/{keyId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자에게서 역할 제거

매개변수

userId `string` (선택) 역할을 제거할 사용자의 이메일입니다. roleId `string` (선택) 사용자에게서 제거할 역할의 ID입니다.

엔드포인트

DELETE /api/users/{userId}/roles/{roleId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/users/{userId}/roles/{roleId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 사용자의 프로필 세부 정보(firstName, lastName, phoneNumber)를 업데이트합니다

매개변수

userId `string` (필수) 사용자의 이메일 주소 body `object` (필수) 업데이트할 사용자 프로필 데이터

엔드포인트

PATCH /api/users/{userId}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/users/{userId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 역할 업서트

매개변수

body `object` (선택)

엔드포인트

PUT /api/users/{userId}/roles

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/users/{userId}/roles \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 AI 에이전트에서 실행 중인 Live Services(게시 선택기)

애플릿의 "Publish to Performance Hub" 선택기를 위해 기기 브리지가 감지한 Live Services를 터널을 통해 가져옵니다. ph-ai-agent 모듈과 기기별 'open' 액세스가 모두 필요합니다(게시 자체와 같은 기준). 해당 포트에 이미 Custom App이 있으면 각 서비스에 publishedAppId가 주석으로 표시됩니다.

매개변수

club `string` (필수) device `string` (필수)

엔드포인트

GET /api/agent-apps/services/{club}/{device}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/services/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 AI 에이전트에 내장된 MDI 아이콘 이름 색인(아이콘 선택기)

기기 브리지에 내장된 MDI 아이콘 색인(GET /__services/icons/mdi/index.json)을 터널을 통해 프록시합니다. 게시/편집 선택기는 애플릿에 번들로 포함된 카탈로그(동일한 7.4.47 고정 버전)를 사용하며, 게시된 앱의 SVG는 portal-server의 로컬 @mdi/js 팩에서 확인됩니다. 서비스 선택기와 액세스 기준이 같습니다(ph-ai-agent 모듈 + 기기별 'open' 액세스).

매개변수

club `string` (필수) device `string` (필수)

엔드포인트

GET /api/agent-apps/mdi-index/{club}/{device}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/mdi-index/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 AI 에이전트에서 MDI 아이콘 SVG 일괄 가져오기(선택기 미리 보기)

기기에 내장된 아이콘 세트에서 이름이 지정된 MDI 글리프를 한 번의 호출로 최대 60개까지 확인하며, 저장된 앱 아이콘에 적용되는 것과 같은 허용 목록으로 서버 측에서 정리합니다. 아이콘 선택기가 검색 결과를 렌더링할 때 사용하며, 알 수 없는 이름은 null로 반환됩니다.

매개변수

club `string` (필수) device `string` (필수)

요청 본문

엔드포인트

POST /api/agent-apps/mdi-icons/{club}/{device}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/mdi-icons/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

요청자가 이 시설에서 게시할 수 있는 대상 범위

게시/편집 선택기에 사용되는, 게시자가 부여할 수 있는 대상 범위입니다. 게시자의 ph-ai-agent 역할이 미치는 시설(다중 시설 범위)과, 이 시설의 브랜드/조직에서 브랜드 전체/조직 전체 대상에 필요한 조직 수준 권한을 보유하고 있는지 여부를 포함합니다. 동일한 규칙이 게시/업데이트 시 서버 측(validatePublishAudience)에서 다시 적용되며, 이 엔드포인트는 UI 구성에만 사용됩니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-apps/audience-options/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/audience-options/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정 사용자 앱 대상의 동료 자동 완성

요청자가 이미 볼 수 있는 사용자만 검색합니다. 즉, 역할이 요청자 자신의 ph-ai-agent 액세스 범위에 속한 시설/지역/조직 중 하나 이상과 겹치는 사람입니다. 최소 2자 검색어와 최대 10개 결과 제한으로 이 엔드포인트를 스크래핑에 사용할 수 없으며, 대상을 저장할 때 서버 측에서 같은 도달 범위가 다시 적용됩니다.

매개변수

club `string` (필수) q `string` (필수)

엔드포인트

GET /api/agent-apps/user-search/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/user-search/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트 Live Service를 Performance Hub Custom App으로 게시

시설의 AI 에이전트가 호스팅하는 웹 앱(브리지가 감지한 Live Service)을 선택한 대상의 "Custom Apps" 사이드 메뉴 항목으로 등록합니다. 이 시설의 ph-ai-agent 모듈과 기기별 'open' 액세스가 모두 필요하며, 대상은 게시자 자신의 역할 범위로 제한됩니다(도달할 수 있는 범위보다 넓게 게시할 수 없습니다). 서비스 식별 정보는 기기의 /__services 목록에서 실시간으로 확인되며, http/https 스킴은 저장되지 않습니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-apps/publish/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/publish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

이 시설에서 볼 수 있는 게시된 Custom Apps

대상에 이 시설이 포함된 활성 게시 앱을 사이드 메뉴가 렌더링하는 형식(appId, name, icon, description)으로 반환합니다. 호출할 때마다 대상을 실시간으로 다시 확인하므로 액세스 변경 사항이 즉시 적용됩니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-apps/menu/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/menu/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설에서 관리하는 게시된 앱(게시자 보기)

애플릿의 "Published Apps" 관리 목록을 위해, 홈 시설이 이 클럽인 앱의 전체 앱 행을 반환합니다. 각 행에는 요청한 사용자(게시자)에 대한 canManage가 주석으로 표시됩니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-apps/manage/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/manage/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

게시된 Custom App용 서비스 범위 뷰어 토큰 발급

브라우저가 기기의 지역 릴레이 게이트웨이에서 게시된 앱 하나를 직접 여는 데 사용하는, 수명이 짧은 서명된 URL과 토큰을 반환합니다. 토큰에는 서비스 포트를 지정하는 svc 클레임이 포함되어 있어 게이트웨이가 세션을 /__services/proxy//로 제한하므로, 이 토큰으로는 에이전트 채팅/터미널에 접근할 수 없습니다. 뷰어에게는 앱 대상에 포함된 시설의 custom-apps 모듈이 필요하며, ph-ai-agent 모듈이나 기기별 에이전트 액세스는 필요하지 않습니다.

매개변수

club `string` (필수) appId `string` (필수)

엔드포인트

POST /api/agent-apps/access/{club}/{appId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/access/{club}/{appId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

게시된 Custom App의 지원 담당(소유자 연락처)

사용자가 게시한 이 앱의 지원 담당자, 즉 게시자의 이메일(없으면 호스팅 에이전트의 소유자)입니다. 뷰어의 오프라인/오류 패널에 표시되어 지원 요청이 Performance Hub가 아닌 앱 소유자에게 전달되도록 합니다. 게시된 앱은 PH 핵심 지원 대상이 아닙니다. 먼저 앱의 대상을 다시 확인하므로, 앱이 공유된 적 없는 뷰어는 아무 정보도 얻지 못합니다. 일시 중지된 앱도 확인됩니다("왜 일시 중지되었나요?"라는 질문도 소유자가 응대합니다).

매개변수

club `string` (필수) appId `string` (필수)

엔드포인트

GET /api/agent-apps/support-info/{club}/{appId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/support-info/{club}/{appId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

게시된 Custom App 소유자에게 지원 요청 이메일 보내기

뷰어의 메시지를 앱의 지원 담당자(게시자, 없으면 에이전트 소유자)에게 브랜드 이메일로 보냅니다. 받는 사람은 소유자, 참조는 뷰어(요청 기록용)이며, 회신 주소를 뷰어로 지정해 소유자가 뷰어에게 바로 회신하도록 합니다. 게시된 앱은 사용자가 유지 관리하므로, 이를 통해 해당 지원이 Performance Hub 대기열로 들어오지 않습니다. 대상을 다시 확인하며, 뷰어당 앱당 15분에 한 번 요청할 수 있습니다(Redis 대기 시간, fail-open).

매개변수

club `string` (필수) appId `string` (필수)

요청 본문

엔드포인트

POST /api/agent-apps/support-request/{club}/{appId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/support-request/{club}/{appId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

게시된 Custom App 업데이트(이름, 아이콘, 설명, 상태, 대상)

게시자만 사용할 수 있습니다. 대상 변경 사항은 게시와 같은 제한 규칙에 따라 편집자의 역할 범위를 기준으로 다시 검증됩니다. 상태는 활성과 일시 중지 사이에서 전환됩니다(일시 중지된 앱은 메뉴에서 사라지고 토큰 발급이 거부됩니다).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-apps/update/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/update/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Custom App 게시 취소(소프트 삭제)

게시자만 사용할 수 있습니다. 레지스트리 행을 소프트 삭제합니다. 앱은 메뉴에서 즉시 사라지고 뷰어 토큰 발급이 거부되며, 이미 발급된 게이트웨이 세션은 토큰이 만료되면 종료됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-apps/unpublish/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/unpublish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

게시된 Custom App의 소유권 이전

AI 에이전트 소유자 재할당 흐름과 같습니다. 현재 게시자 또는 계정 소유자(billing 모듈)가 앱을 다른 사용자에게 넘길 수 있으며, 이후 그 사용자가 앱을 관리합니다. 새 소유자는 앱의 홈 클럽에 대한 시설 액세스 권한이 있어야 합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-apps/transfer-owner/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/transfer-owner/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 AI 에이전트에 준비된 스킬 내보내기(공유 선택기)

애플릿의 "Share a skill" 선택기를 위해 기기 브리지의 준비된 내보내기 목록(GET /__skills/exports)을 터널을 통해 프록시합니다. 내보내기는 기기 내 ph-skill-sharing 보안/이식성 검사를 거쳐 준비되며, 각 항목에는 기기 측 검사 결과가 포함됩니다. ph-ai-agent 모듈과 기기별 'open' 액세스가 모두 필요합니다(게시 자체와 같은 기준).

매개변수

club `string` (필수) device `string` (필수)

엔드포인트

GET /api/agent-skills/exports/{club}/{device}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/exports/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

준비된 스킬 내보내기를 새 공유 스킬로 게시(초안 버전)

지정한 준비된 내보내기 tarball을 터널을 통해 기기 브리지에서 가져와 메모리에서 압축을 풀고(경로 탐색/심볼릭 링크/크기 초과는 거부), 클라우드 측 결정적 보안 검사를 실행하고, SKILL.md frontmatter로 매니페스트를 작성한 다음, tarball을 콘텐츠 주소 방식으로 비공개 스킬 버킷에 저장하고 스킬 헤드와 초안 버전을 생성합니다. 검사에서 차단되면 아무것도 저장하지 않고 검사 결과를 반환합니다. 대상은 게시자 자신의 역할 범위로 제한됩니다. 게시하려면 초안을 제출하십시오(POST submit).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/publish/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/publish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

준비된 내보내기를 기존 공유 스킬의 새 버전으로 게시

기존 스킬을 대상으로 게시와 같은 파이프라인을 실행합니다. 내보내기의 SKILL.md 이름이 스킬과 일치해야 하고, 버전은 새 버전이어야 하며(버전은 변경할 수 없습니다), 변경 로그가 필요합니다. 버전은 게시자만 추가할 수 있습니다. 검사에서 차단되면 상태가 'rejected'인 버전 행(보고서만, 아티팩트 없음)을 저장하여 검사 결과가 게시자의 기록에 표시되도록 합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/new-version/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/new-version/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

스킬 버전 하나의 전체 검사 보고서(+ LLM 검토)

버전의 전체 검사 결과 목록입니다. 게시자와 조직 관리자(승인 검토)만 볼 수 있으며, 설치자는 대신 스킬 세부 정보에서 요약된 개수를 확인합니다.

매개변수

club `string` (필수) skillId `string` (필수) version `string` (필수)

엔드포인트

GET /api/agent-skills/scan-report/{club}/{skillId}/{version}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/scan-report/{club}/{skillId}/{version} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

초안 스킬 버전 제출(게시 또는 승인 대기열에 추가)

조직의 거버넌스에 따라 초안 버전을 다음 단계로 진행합니다. 조직이 LLM 검토를 선택한 경우 지침 검토가 먼저 실행됩니다(최선 노력 방식이며, 'fail' 판정은 거부되고 'flag' 판정은 승인 대기열로 보내집니다). 시설 수준 공유는 거버넌스에서 승인을 요구하지 않는 한 즉시 게시되며, 조직 라이브러리 공유(브랜드/조직 대상)는 기본적으로 승인이 필요합니다. 게시하면 스킬의 latestVersion이 설정되며, 'auto' 정책 설치는 다음 조정 주기에 이를 반영합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/submit/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/submit/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

공유 스킬 목록에서 내리기(라이브러리에서 제거)

게시자만 사용할 수 있습니다. 스킬이 라이브러리에서 즉시 사라지고 새 설치가 거부되지만, 기존 설치는 계속 작동합니다. 목록에서 내리기는 목록 관리 작업일 뿐 강제 중지 기능이 아닙니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/delist/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/delist/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

공유 스킬의 목록 정보 편집(표시 이름, 설명, 아이콘)

게시자만 사용할 수 있습니다. 표시 전용 필드입니다. 정식 스킬 이름은 스킬의 식별자(매니페스트, 설치 디렉터리, 버전 일치)이며 변경되지 않습니다. 빈 문자열을 입력하면 필드가 null로 초기화됩니다(정식 이름/아이콘 없음으로 대체). 아이콘은 게시된 에이전트 앱과 같은 형식인 MDI 카탈로그(mdi:icon-name)를 사용합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/update-listing/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/update-listing/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

공유 스킬의 소유권 이전

게시된 앱 이전 흐름과 같습니다. 현재 게시자 또는 계정 소유자(billing 모듈)가 스킬을 다른 사용자에게 넘길 수 있으며, 이후 그 사용자가 스킬의 버전과 목록 정보를 관리합니다. 새 소유자는 스킬의 홈 클럽에 대한 시설 액세스 권한이 있어야 합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/transfer-owner/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/transfer-owner/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

이 시설에서 볼 수 있는 스킬 라이브러리(대상 기준 필터링)

게시된 버전이 하나 이상 있고 대상에 이 시설이 포함된(또는 뷰어가 지정된) 활성 스킬이며, 최신 게시 버전 요약과 조직 내 도입 현황(원시 설치 수가 아닌 고유 시설 수)이 주석으로 표시됩니다. 호출할 때마다 대상을 실시간으로 다시 확인합니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-skills/library/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/library/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

스킬 세부 정보(버전, 요구 사항, 검사 요약, 도입 현황)

라이브러리 스킬 하나의 전체 세부 정보입니다. 변경 로그와 검사 요약이 포함된 버전 기록(버전별 엔드포인트 목록은 업데이트 검사 비교에 사용됩니다), 매니페스트에 선언된 요구 사항, 게시자 출처 및 시설 수 기준 도입 지표를 포함합니다. 대상을 다시 확인하므로, 스킬이 공유된 적 없는 뷰어는 아무 정보도 얻지 못합니다(게시자와 조직 관리자는 항상 볼 수 있습니다).

매개변수

club `string` (필수) skillId `string` (필수)

엔드포인트

GET /api/agent-skills/skill/{club}/{skillId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/skill/{club}/{skillId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설에서 게시한 스킬(게시자 관리 목록)

홈 시설이 이 클럽인 전체 스킬 행이며, 각 행에는 요청한 사용자에 대한 canManage와 최신 버전 요약이 주석으로 표시됩니다(초안과 승인 대기 항목 포함, 게시자의 작업 보기입니다).

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-skills/manage/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/manage/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 AI 에이전트에 라이브러리 스킬 설치

거버넌스로 제한됩니다. 조직의 installSources에서 허용해야 하고, 스킬의 대상에 이 시설이 포함되어야 하며(또는 요청자가 지정되어야 함), 버전이 게시되어 있어야 하고, 요청자가 대상 기기의 whoCanInstall 등급(소유자/허용된 사용자/시설 관리자/조직 관리자, 거버넌스 참조)을 충족해야 합니다. 설치 수명 주기 행(기준 데이터)을 기록하고 최선 노력 방식으로 즉시 푸시하며, 기기에 연결할 수 있게 되면 조정 cron이 전달을 보장합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/install/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/install/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

설치 하나에 대한 대기 중인 스킬 업데이트 승인

설치의 desiredVersion을 최신 게시 버전으로 옮깁니다('notify' 및 'pinned' 정책의 수동 단계이며, 거버넌스에서 updatePosture를 'approvalRequired'로 설정한 경우의 경로입니다). 현재 버전을 한 단계 롤백 대상으로 유지하고 롤백 후 업데이트 고정(skipVersion)을 해제합니다. 설치와 같은 whoCanInstall 권한 등급이 필요합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/update-approve/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/update-approve/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

설치된 스킬을 이전 버전으로 롤백

desiredVersion을 설치 행의 previousVersion(버전이 바뀔 때마다 보관됨)으로 설정하고 일반 전달 경로를 통해 다시 설치합니다. 한 단계 방식이므로 버전이 서로 바뀌며, 두 번 롤백하면 원래 상태로 돌아갑니다. 또한 업데이트를 고정하여(skipVersion = 롤백 전 버전) auto/notify 정책이 롤백 상태를 유지하도록 합니다. 이 고정은 더 새로운 버전이 게시되거나, update-approve 또는 set-policy를 실행하면 해제됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/rollback/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/rollback/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 AI 에이전트에서 스킬 제거

설치 행을 pending-uninstall로 표시하고 원하는 상태를 푸시합니다. 기기가 제거를 확인하면(조정 시 다시 읽기) 행이 삭제됩니다. 설치와 같은 whoCanInstall 권한 등급이 필요합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/uninstall/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/uninstall/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

기기 하나에서 스킬의 설치별 업데이트 정책 설정

auto(조직의 updatePosture에서 승인을 요구하지 않는 한 조정 시 새 게시 버전을 자동으로 적용), notify(새 버전마다 소유자에게 한 번 알리며 소유자가 직접 적용) 또는 pinned(명시적인 update-approve 없이는 변경되지 않음) 중 하나입니다. 정책을 변경하면 롤백 후 업데이트 고정(skipVersion)이 해제됩니다. 설치와 같은 whoCanInstall 권한 등급이 필요합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/set-policy/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/set-policy/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 AI 에이전트에 설치된 스킬(Skills 탭)

기기 하나의 설치 수명 주기 행이며, 각 행에는 스킬의 목록 필드와 더 새로운 게시 버전이 있는지 여부가 주석으로 표시됩니다. 기기별 'open' 액세스가 필요합니다(Skills 탭은 에이전트 서랍 안에 있습니다).

매개변수

club `string` (필수) device `string` (필수)

엔드포인트

GET /api/agent-skills/installs/{club}/{device}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/installs/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설의 조직에서 승인 대기 중인 스킬 버전

조직 관리자 승인 대기열입니다. 조직의 모든 스킬에서 승인 대기 중인 버전을 스킬 목록 정보 및 검사/LLM 요약과 함께 표시합니다. 조직 관리자만 사용할 수 있습니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-skills/approvals/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/approvals/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

대기 중인 스킬 버전 승인(게시됨)

조직 관리자만 사용할 수 있습니다. 버전이 게시되고 스킬의 latestVersion이 변경되며 게시자에게 알림이 전송됩니다. 'auto' 정책 설치는 다음 조정 주기에 이 버전을 반영합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/approve/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/approve/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

대기 중인 스킬 버전 거부

조직 관리자만 사용할 수 있습니다. 버전이 검토자의 사유와 함께 거부되고 게시자에게 알림이 전송됩니다. 게시자는 검사 결과를 수정한 후 새 버전을 제출할 수 있습니다(버전은 변경할 수 없습니다).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/reject/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/reject/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

이 시설 조직의 유효한 Agent Skill 거버넌스

플랫폼 기본값에 저장된 조직별 정책을 병합한 결과입니다(저장된 행이 없는 조직은 기본값만 표시됩니다). 조직 관리자만 사용할 수 있습니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/agent-skills/governance/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/governance/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설 조직의 Agent Skill 거버넌스 업데이트

부분 업데이트입니다. 제공된 필드만 변경되며 나머지는 저장된 값 또는 기본값을 유지합니다. 조직 관리자만 사용할 수 있습니다. 기기별 재정의는 기존 기기 구성 경로를 통해 등록 행에 저장됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/agent-skills/governance/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/governance/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 환경 데이터 가져오기

지정한 클럽의 일출/일몰을 포함한 현재 기상 상태(Open-Meteo 제공)와 시설 실내 온도(비상 경보 센서 제공)를 반환합니다. Redis에 30분 동안 캐시됩니다.

매개변수

clubId `string` (필수) 클럽/시설의 내부 ID

엔드포인트

GET /api/clubs/{clubId}/environment

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/environment \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

일반 IoT 기기를 클럽에 추가/연결합니다.

매개변수

club `string` (필수) 기기를 추가할 클럽의 내부 ID입니다. body `string` (필수) 연결할 새 스크린의 JSON 객체입니다.

엔드포인트

POST /api/devices/addGenericDevice/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/addGenericDevice/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

디스플레이 스크린 제거 및 초기화

스크린의 활성 시설 연결을 제거하고 유지되는 초기화를 예약합니다. 전원이 꺼진 스크린은 다음에 전원이 켜지고 다시 연결된 후 초기화를 적용한 다음 HDMI 페어링 페이지로 돌아갑니다. 이전 결제 기록은 보존됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/display-screens/reset/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/display-screens/reset/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

도어 컨트롤러를 시설에 연결합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/door-controllers/associate/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/door-controllers/associate/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 도어 컨트롤러 설정을 업데이트합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/door-controllers/update/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/door-controllers/update/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설에서 도어 컨트롤러를 해제합니다.

매개변수

club `string` (필수)

엔드포인트

POST /api/devices/door-controllers/decommission/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/door-controllers/decommission/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

도어 컨트롤러의 릴레이 구성을 반환합니다.

매개변수

uuid `string` (필수)

엔드포인트

GET /api/devices/door-controllers/config/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/door-controllers/config/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기의 메타데이터를 반환합니다

매개변수

uuid `string` (필수) 기기의 고유 ID

엔드포인트

GET /api/devices/metadata/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/metadata/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기의 메타데이터를 반환합니다. 응답은 최상위 수준의 메타데이터 행(레거시 형식)과 `detectedType`(camera | ai-edge-processor | door-controller | ph-ai-agent | null) 및 `online`(5분 이내에 업데이트된 경우 true)으로 구성됩니다.

매개변수

deviceSerialNumber `string` (필수) 기기의 일련번호

엔드포인트

GET /api/devices/metadata/serial/{serialNo}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/metadata/serial/{serialNo} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 Smart Club 데이터를 반환합니다.

매개변수

club_id `string` (필수) 기기를 추가할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club_id}/smart-club-data

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club-data \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

개별 클럽에 연결된 모든 기기를 반환합니다.

매개변수

club `string` (필수) 기기를 나열할 클럽의 내부 ID입니다.

엔드포인트

GET /api/devices/list/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

balena 기기의 모든 애플리케이션 릴리스(버전)를 반환합니다.

엔드포인트

GET /api/devices/listReleases

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/listReleases \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기를 새 시설(클럽)로 이동하고 관련 시스템을 업데이트합니다.

매개변수

club `string` (필수) 원본 시설 ID(기기가 현재 속한 클럽) body `object` (필수) 이동 매개변수

엔드포인트

POST /api/devices/move/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/move/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 내에서 가장 적합한 기기를 선택하고 터널을 생성하는 MQTT 명령을 보내 시설의 라우터에 연결을 시도합니다.

매개변수

facilityID `string` (필수) 라우터 연결을 시도하는 시설의 내부 ID입니다.

엔드포인트

GET /api/devices/openRouterWebpage/{facilityID}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/openRouterWebpage/{facilityID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Cloud Agent 카탈로그(영역, 크기, 실시간 판매 가격)

매개변수

club `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/cloud/catalog/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/catalog/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Cloud Agent 견적(소프트웨어 + 호스팅)

엔드포인트

POST /api/devices/ph-ai-agent/cloud/quote/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/quote/{club} \
  -H "x-api-key: YOUR_API_KEY"

Cloud Agent 시작(프로비저닝 대기열 추가 + 자동 연결)

엔드포인트

POST /api/devices/ph-ai-agent/cloud/launch/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/launch/{club} \
  -H "x-api-key: YOUR_API_KEY"

Cloud Agent 작업 상태

엔드포인트

GET /api/devices/ph-ai-agent/cloud/jobs/{club}/{jobId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/jobs/{club}/{jobId} \
  -H "x-api-key: YOUR_API_KEY"

Cloud Agent 완전 삭제(VM + balena + 등록)

엔드포인트

POST /api/devices/ph-ai-agent/cloud/delete/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/delete/{club} \
  -H "x-api-key: YOUR_API_KEY"

보류된 Cloud Agent 제거 처리(백업 재시도, 백업 없이 삭제 또는 취소)

엔드포인트

POST /api/devices/ph-ai-agent/cloud/delete-decision/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/delete-decision/{club} \
  -H "x-api-key: YOUR_API_KEY"

에이전트의 Connected Apps 나열(제품군 + 연결된 계정이 있는 앱)

에이전트의 Connected Apps 상태를 반환합니다. 사용 설정 플래그, 제품군별 요약(Google Workspace, Microsoft 365), 그리고 에이전트의 업스트림 세션에서 확인한 각 앱의 연결된 계정이 포함된 엄선된 앱 카탈로그(다중 계정: 에이전트는 앱마다 여러 계정을 보유할 수 있으며 각 계정에 선택적 별칭을 지정할 수 있음)를 포함합니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

엔드포인트

GET /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

에이전트의 전체 Connected Apps 마켓플레이스 카탈로그

연결 가능한 모든 앱(서버 측에 약 12시간 캐시되는 전체 관리형 인증 툴킷 카탈로그)을 추천/제품군 등급 및 앱별 에이전트의 연결된 계정과 함께 반환하며, 제품군별 요약과 에이전트의 대기 중인 연결 요청도 포함합니다. 클라이언트 측에서 검색할 수 있는 앱 마켓플레이스를 위한 단일 페이로드입니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

엔드포인트

GET /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/catalog

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/catalog \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

대기 중인 에이전트 연결 요청 닫기

툴킷에 대한 에이전트의 대기 중인 연결 요청을 닫힘으로 표시합니다(마켓플레이스의 "Requested by your agent" 섹션에서 사라집니다). 멱등 작업이므로 대기 중이 아닌 요청을 닫으면 아무 작업도 수행되지 않습니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/requests/dismiss

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/requests/dismiss \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트의 Connected Apps 사용 설정 또는 해제

에이전트의 Connected Apps 스위치 상태를 저장하고 PH_APPS_MCP_ENABLED Balena 기기 변수를 해당 기기에 푸시합니다(최선 노력 방식이며, MCP 릴레이를 실제로 제한하는 것은 PH 측 플래그입니다).

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/enable

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/enable \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트에 단일 앱 연결 시작(Connect Link OAuth 흐름)

툴킷 하나에 대해 호스팅된 Connect Link 흐름을 시작하고 사용자를 보낼 URL을 반환합니다. 선택적 별칭으로 새 계정에 레이블을 지정할 수 있습니다(다중 계정: 이미 연결된 앱을 다시 연결하면 계정이 하나 더 추가되며 앱당 최대 10개). 제품군 연결과 같은 연쇄 콜백(툴킷이 하나인 제품군)을 거치므로 완료되면 ph-ai-agent 애플릿 페이지로 돌아옵니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

앱 하나의 연결 준비 페이로드(모드, 자격 증명 필드, 설정 가이드)

연결 대화 상자가 연결을 시작하기 전에 필요한 모든 정보입니다. 앱의 연결 방식(oauth = 호스팅된 동의 흐름, credentials = 제품 내 양식), credentials 모드에서 수집할 자격 증명 필드, 그리고 제품 내 설정 가이드(우선순위 앱은 직접 작성, 그 외에는 앱의 필드 메타데이터에서 생성하며 외부 문서 링크는 제공하지 않음)를 포함합니다. 자체 OAuth 앱(BYO)의 경우 고객의 OAuth 앱이 이 에이전트에 이미 등록되었는지 여부(byoConfigured)와 공급자에 등록할 리디렉션 URL도 포함합니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다. toolkit `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-info/{toolkit}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-info/{toolkit} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자가 제공한 자격 증명으로 앱 연결(API 키 등, OAuth 없음)

호스팅된 동의 흐름 없이 제품 내 양식에서 바로 credentials 모드 앱의 연결된 계정을 생성합니다. 자격 증명 필드는 앱의 connect-info 페이로드에서 가져오며, 모든 필수 필드를 제공해야 합니다. 지원되는 경우 공급자를 통해 자격 증명을 검증합니다(최선 노력 방식이며, 일부 앱은 에이전트의 첫 번째 도구 호출 시에만 잘못된 키를 거부합니다). 선택적 별칭으로 새 계정에 레이블을 지정할 수 있습니다(다중 계정: 이미 연결된 앱을 다시 연결하면 계정이 하나 더 추가됩니다).

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-credentials

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-credentials \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

BYO 앱에 고객 자체 OAuth 앱을 등록하고 연결 흐름 시작

자체 OAuth 앱(Xero, Shopify 등)용입니다. 고객이 공급자에서 생성한 OAuth 앱(앱의 설정 가이드에서 안내)의 클라이언트 ID와 클라이언트 시크릿을 받아 이 에이전트에 등록하고(시크릿은 업스트림 통합 플랫폼에만 저장되며 Performance Hub에는 저장되지 않음), 해당 앱으로 호스팅된 로그인 흐름을 즉시 시작합니다. 연결 엔드포인트와 같은 계약으로, 사용자를 보낼 동의 URL을 반환합니다. 다시 제출하면 에이전트에 등록된 앱이 대체되며(예: 시크릿 교체 후), 기존 연결된 계정은 계속 작동합니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-oauth-app

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-oauth-app \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트의 원클릭 제품군 연결 시작(연쇄 Connect Link 흐름)

제품군 전체(예: google-workspace)에 대한 연쇄 연결 흐름을 시작합니다. 반환된 URL은 첫 번째 툴킷의 동의 화면을 열며, 각 단계가 완료될 때마다 302로 다음 툴킷의 흐름으로 바로 이동하고 ph-ai-agent 애플릿 페이지에서 끝납니다. 이미 연결된 계정이 있는 구성원은 건너뛰므로, 중간에 실패한 후 다시 시도하면 중복 계정을 만들지 않고 누락된 앱부터 다시 진행합니다. 모든 구성원이 이미 연결되어 있으면 전체 흐름이 다시 실행되며, 이것이 명시적인 "다른 계정 추가" 흐름입니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-suite

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-suite \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트에서 연결된 계정 하나 연결 해제

연결된 계정 하나를 삭제합니다(다중 계정: 같은 앱의 다른 계정은 연결된 상태로 유지됨). 삭제하기 전에 계정이 이 에이전트에 속하는지 검증하며, 앱의 마지막 계정이었으면 에이전트의 연결 집합에서 툴킷이 제거됩니다(에이전트의 도구 목록이 업데이트되도록 세션이 지연 방식으로 다시 생성됨).

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/disconnect

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/disconnect \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트의 연결된 계정 하나의 이름 변경(별칭 재지정)

연결된 계정 하나의 표시 별칭을 설정합니다. 별칭은 일반적으로 OAuth 후 로그인한 ID를 기준으로 자동 설정되며, 이 엔드포인트는 앱 세부 정보 대화 상자의 수동 이름 변경 기능에 사용됩니다. 빈 별칭을 지정하면 레이블이 지워집니다. 업스트림을 업데이트하기 전에 계정이 이 에이전트에 속하는지 검증합니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/rename-account

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/rename-account \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

에이전트의 기본 제공 Performance Hub 서비스 전환

이 에이전트에서 상시 사용되는 기본 제공 서비스(Smart Search, Weather 등) 하나를 켜거나 끕니다. 기본 제공 서비스는 연결이나 OAuth가 필요 없으며 모든 에이전트에 포함되고 기본적으로 켜져 있습니다. 이 전환은 에이전트별 재정의를 저장하고 도구 세트가 업데이트되도록 에이전트의 업스트림 세션을 즉시 다시 생성합니다. 별도의 "External apps" 스위치(/enable 경로)는 앱 MCP 서버 전체를 강제로 끄는 스위치이므로, 이 스위치가 꺼져 있으면 개별 전환 상태와 관계없이 기본 제공 서비스도 사용할 수 없습니다.

매개변수

facilityId `string` (필수) deviceId `string` (필수) 에이전트 기기의 balena UUID입니다. slug `string` (필수) 기본 제공 서비스 슬러그입니다.

요청 본문

엔드포인트

PATCH /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/built-in/{slug}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/built-in/{slug} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 기기를 시설에 연결

메타데이터 우선 연결입니다. 실시간 기기 메타데이터에서 일련번호로 기기를 조회하고 기기가 온라인 상태인지 확인한 다음, 등록 행을 지연 방식으로 생성하고, Chisel 릴레이 리전 + 터널 포트 + 시크릿을 할당하고, 릴레이에 해당 슬롯을 등록한 후, Balena를 통해 시설 + 터널 구성을 기기에 푸시합니다. 새 기기에는 기본 MCP 서비스 계정(사용 설정됨, 이 시설로 범위 지정, 모든 기능)도 함께 생성되며, 다시 페어링해도 기존 MCP 권한은 유지됩니다. 선택적 고급 설정으로 페어링 시 적용되는 기본값(백업 구성, MCP 켜기/끄기, 액세스 제한)을 재정의할 수 있으며, `restoreFrom`은 다른 시설 기기의 클라우드 백업(활성 또는 해제된 원본)으로 새 기기를 초기화합니다(교차 저장소 복원을 대기열에 추가하며, 진행 상황 폴링을 위해 `restoreRequest`로 반환됨).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/associate/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/associate/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 AI 에이전트 기기 나열

시설의 AI 에이전트 기기를 실시간 온라인 + 터널 상태와 함께 반환합니다(애플릿 기기 전환기에서 사용).

매개변수

club `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/list/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트 업데이트 + 온라인 상태

기기가 온라인인지, 업데이트를 사용할 수 있거나 대기 중인지, 그리고 제공되는 릴리스(플릿이 고정된 경우 플릿 고정 버전, 플릿이 최신 버전을 따르는 경우 성공한 최고 버전)를 반환합니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/update-status/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update-status/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트 실시간 기기 상태 + 지표

애플릿의 지표 표시줄과 관리 서랍에 사용할 정리된 스냅숏을 반환합니다. 식별 + 등록 필드, 활성 상태 + 연결, 소프트웨어 버전, 최신 하트비트 지표(CPU, 온도, 메모리, 마운트별 스토리지, 가동 시간, 네트워크)를 포함합니다. 기기 메타데이터 비컨과 Balena 업데이트 상태를 하나로 합치며, 일시적인 장애 시 둘 중 하나가 누락될 수 있습니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/device-status/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/device-status/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기 상태 보고서용 AI 설명

현재 도출된 상태 문제에 대해 운영자용 짧은 설명을 반환합니다. 사실 정보와 대응 절차는 항상 device-status에 있으며, 이 추가 단락은 최선 노력 방식으로 제공되므로 null일 수 있습니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

POST /api/devices/ph-ai-agent/health/{club}/{uuid}/explain

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/health/{club}/{uuid}/explain \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트용 릴레이 직접 액세스 토큰 발급

브라우저가 기기의 지역 릴레이 게이트웨이에 직접 연결하는 데 사용하는 수명이 짧은 서명된 URL(글로벌 PH/시드니 경유를 생략)과 HS256 토큰을 반환합니다. 권한 관리는 계속 PH가 담당하며(여기서 Google SSO + 모듈/시설 확인), 릴레이 게이트웨이가 토큰을 검증합니다. /ai-agent-ui 프록시는 대체 경로로 유지됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/access/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 세션에 채팅 메시지 보내기(알림 인라인 답장)

웹 푸시 알림의 인라인 답장 작업에 사용되는 서버 측 릴레이입니다. 서비스 워커가 이곳으로 POST하므로(동일 출처, SSO 쿠키) Performance Hub 탭을 열지 않아도 답장할 수 있습니다. PH는 기기의 릴레이 대상을 확인하고(/ai-agent-ui 프록시와 같은 조회), 턴 귀속을 위해 x-ph-user를 지정한 후(이후 완료 푸시는 이 사용자에게 전송됨), 세션 ID와 함께 기기의 /api/chat/start로 전달합니다.

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/reply

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/reply \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트의 액세스 제어 설정 읽기(소유자)

기기의 액세스 블록(모드, 허용 목록, 표시 범위, PH 지원 전환)과 대기 중인 액세스 요청을 반환합니다. 기기 소유자만 읽을 수 있으며, 다른 사용자에게는 403이 반환됩니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/access-settings/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-settings/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트의 액세스 제어 설정 업데이트(소유자)

모드(org/restricted), 제한 허용 목록, 목록 표시 범위(all/admins) 및 "Permit access from Performance Hub Support" 전환을 기록합니다. 기기 소유자가 사용할 수 있습니다. 소유자 자체는 reallocate-owner를 통해서만 변경할 수 있습니다. 승인된 액세스 요청은 유지되므로, 여전히 승인된 요청자는 저장된 허용 목록에 다시 합쳐집니다. 제출한 목록에서 요청자를 제거하면 승인이 철회됩니다(요청이 거부됨으로 바뀌며 다시 요청할 수 있음).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/access-settings/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-settings/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트의 소유자 재할당

기기 소유권을 다른 Performance Hub 사용자에게 재할당합니다. 계정 소유자(SaaS 결제 모듈 액세스)로 제한되며, 제한된 에이전트의 소유자가 떠났을 때 사용하는 비상 수단입니다. 이전 소유자와 새 소유자 모두에게 알림이 전송됩니다(앱 내 + 푸시 + 이메일).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/reallocate-owner/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/reallocate-owner/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 허용 목록/소유자 선택기용 시설 사용자 목록

역할에 따라 이 시설에 액세스할 수 있는 모든 사용자의 이메일 + 이름(+ isOrgAdmin 플래그)을 반환합니다. 일반 사용자가 사용자 목록을 열람할 수 없도록 기기 소유자와 재할당 권한자(계정 소유자)로 제한됩니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/org-users/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/org-users/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

제한된 AI 에이전트에 대한 액세스 요청

제한된 기기에 대한 요청자의 액세스 요청을 생성하거나 다시 엽니다(사용자+기기 단위로 멱등). 소유자에게 에이전트 모듈로 연결되는 딥 링크와 함께 앱 내, 웹 푸시 및 이메일로 알림이 전송됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/access-request/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-request/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 액세스 요청 승인 또는 거부(소유자)

기기 소유자가 대기 중인 요청을 처리합니다. 승인하면 요청자가 기기의 허용 목록에 추가되며, 어느 결과든 요청자에게 알림이 전송됩니다(앱 내 + 푸시 + 이메일).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/access-request-resolve/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-request-resolve/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 업데이트 허용 + 적용

기기를 제공된 릴리스(플릿 고정 버전, 또는 플릿이 최신 버전을 따르는 경우 성공한 최고 버전)에 고정하고 업데이트 잠금을 해제하여 balena supervisor가 업데이트를 적용하도록 합니다. 기기 데이터 볼륨의 상태는 업데이트 후에도 유지됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/update/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 업데이트 예약

기기 등록 정보에 예약 설치 시간을 저장합니다. 반복 백엔드 작업(5분마다)이 예약 시간이 지나면 업데이트(고정 + 잠금 해제)를 적용합니다. 새로 예약하면 해당 기기의 기존 예약이 대체됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/update-schedule/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update-schedule/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

예약된 AI 에이전트 업데이트 취소

기기의 대기 중인 예약 설치를 지웁니다(예약된 항목이 없으면 아무 작업도 수행되지 않음).

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

DELETE /api/devices/ph-ai-agent/update-schedule/{club}/{uuid}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update-schedule/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트 기기에서 원격 명령 실행

허용 목록에 있는 MQTT 명령(재부팅, 컨테이너 재시작, 업데이트 잠금/잠금 해제, Wi-Fi 관리)을 AI 에이전트에서 실행 중인 device-controller에 게시합니다. 기기는 시설에 연결되어 있어야 합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/command/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/command/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트의 시설용 구성 업데이트

연결된 AI 에이전트에 대해 운영자가 편집할 수 있는 설정(기기 이름, 기기의 물리적 위치, 예약 재부팅 주기)을 저장합니다. 재부팅 일정은 REBOOT_DEVICE Balena 환경 변수(현지 시간 오전 2시)로도 기기에 전달되며, Display Screens의 동작과 동일합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/config/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/config/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

이 시설의 AI 에이전트를 이동할 수 있는 시설

"다른 시설로 이동" 선택기에 사용할, 로그인한 사용자가 접근할 수 있는 같은 조직의 시설(현재 시설 제외)을 반환합니다. 실제 이동은 POST /api/devices/move/:club에서 수행되며, 이 엔드포인트는 같은 조직 및 대상 접근 권한 규칙을 서버 측에서 동일하게 적용합니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/move-targets/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/move-targets/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 AI 에이전트에 대해 요청자가 부여할 수 있는 MCP 접근 범위

로그인한 사용자가 이 시설 조직의 AI 에이전트 MCP 서비스 계정에 부여할 수 있는 항목을 반환합니다. 여기에는 사용자 자신의 접근 범위 내 시설/지역, 조직 전체 범위를 부여할 수 있는지 여부, 사용자가 보유한 모듈 전체, 그리고 전체 MCP 도구 카탈로그(고급 도구별 마스크용)가 포함됩니다. UI는 이를 사용하여 사용자가 자신의 권한 범위 내 옵션만 보도록 하며, mcp-access POST 엔드포인트는 서버 측에서 동일한 축소 규칙을 적용합니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/mcp-grantable/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/mcp-grantable/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트의 MCP 서비스 계정 구성 가져오기

기기의 MCP 접근 구성(범위, 모듈, 도구 마스크, 감사 필드)을 반환합니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/mcp-access/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/mcp-access/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트의 MCP 서비스 계정 구성

부여 시점 축소 규칙을 적용하여 기기의 MCP 접근 구성을 저장합니다. 요청자는 자신의 접근 범위 내 시설/지역만 부여할 수 있고, 조직 전체 역할을 보유한 경우에만 조직 범위를 부여할 수 있으며, 이 시설의 조직에서 자신이 보유한 모듈만 부여할 수 있습니다. 활성화 플래그는 PH_MCP_ENABLED Balena 환경 변수로도 기기에 전달됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/mcp-access/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/mcp-access/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트의 VPN 구성 가져오기(민감 정보 제외)

기기의 VPN 지원 플래그와 연결 목록을 반환합니다. 프로필 본문과 자격 증명 값은 반환되지 않으며, 가져오기 시점의 메타데이터(원격 서버, 경로, DNS)와 자격 증명 보유 여부 플래그만 반환됩니다. 연결별 실시간 상태는 device-status 엔드포인트(beacon metadata.vpn)에서 제공됩니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/vpn-config/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-config/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트의 VPN 지원 전환

기기의 VPN 기능을 켜거나 끕니다. PH_VPN_ENABLED balena 기기 변수를 전달하고 기기에 알림(MQTT vpnConfigChanged)을 보냅니다. 기능을 끄더라도 연결은 유지됩니다(터널은 중지되고 구성은 다시 활성화할 수 있도록 보존됩니다).

매개변수

club `string` (필수) uuid `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/vpn-config/{club}/{uuid}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-config/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트에 OpenVPN 프로필 가져오기

base64로 인코딩된 업로드를 받습니다. 단일 .ovpn/.conf 파일, 분할 파일 번들(구성 + 인증서/키), 아카이브(.zip, .tar/.tgz Pritunl 내보내기, .tblk Tunnelblick, .visc/.visz Viscosity)를 지원합니다. 프로필은 표준 인라인 형식으로 정규화되며, 각 프로필은 하나의 연결이 됩니다(연결 해제 상태로 가져오므로 자격 증명을 입력한 후 연결하십시오). 사용할 수 없는 업로드에는 조치 방법이 포함된 400 오류를 반환합니다.

매개변수

club `string` (필수) uuid `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/vpn-import/{club}/{uuid}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-import/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 VPN 연결 업데이트(이름/자격 증명/분할 DNS)

저장된 연결을 업데이트합니다. 자격 증명 필드는 쓰기 전용입니다(생략하면 저장된 값을 유지하고, 빈 문자열이면 지웁니다). 자격 증명 또는 분할 DNS를 변경하면 연결 리비전이 올라가므로 활성 터널이 새 값으로 다시 시작됩니다.

매개변수

club `string` (필수) uuid `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/vpn-connection/{club}/{uuid}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-connection/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 VPN 연결 삭제

등록 정보에서 연결을 제거하고 기기에 알림을 보냅니다. 기기는 터널을 해제하고 캐시된 프로필/자격 증명을 삭제합니다.

매개변수

club `string` (필수) uuid `string` (필수) connectionId `string` (필수)

엔드포인트

DELETE /api/devices/ph-ai-agent/vpn-connection/{club}/{uuid}/{connectionId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-connection/{club}/{uuid}/{connectionId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트 VPN 연결 연결/연결 해제

원하는 상태(desired-state) 모델입니다. 등록 정보에서 연결의 활성화 플래그를 설정하고 기기에 알림(페이로드 없는 MQTT vpnConfigChanged)을 보냅니다. 기기는 JWT 인증 universal-api 호출을 통해 권한 있는 상태를 가져와 터널을 조정합니다. 알림을 놓치더라도 주기적 동기화 시 상태가 맞춰집니다.

매개변수

club `string` (필수) uuid `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/vpn-command/{club}/{uuid}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-command/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트의 클라우드 백업 구성 및 상태 가져오기

기기의 백업 설정(활성화, 보존 기간, 스토리지 지역), 최근 백업 상태(마지막 백업, 크기, 오류), 확정된 자동 지역, 선택기에 표시할 사용 가능한 스토리지 지역을 반환합니다. restic 저장소 비밀번호는 반환되지 않습니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-config/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-config/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트의 클라우드 백업 구성 업데이트

활성화/보존 기간/지역을 저장합니다. 기기의 다음 시간별 백업 주기에 적용되므로(기기는 매 실행 전에 PH에 실행 컨텍스트를 요청합니다) 기기를 다시 시작할 필요가 없습니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/backup-config/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-config/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

새 AI 에이전트 페어링용 백업 복원 소스 목록

에이전트 추가 대화 상자의 "백업에서 복원" 옵션을 위한 시설 전체 보기입니다. 복호화할 수 있는 백업 저장소와 사용 가능한 복원 지점이 하나 이상 남아 있는 시설 내 모든 등록(활성 및 해제/교체된 등록 포함)을 최신 스냅샷과 함께 반환합니다. 또한 백업 구성 옵션 목록(allowedRetentionDays, availableRegions)을 반환하므로 대화 상자는 기기 UUID 없이도 선택 항목을 채울 수 있습니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-sources/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-sources/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI 에이전트의 백업 복원 지점 목록

DynamoDB에서 기기의 스냅샷 인덱스(최신순)를 반환하며, 기기나 저장소를 왕복 조회하지 않습니다. 또한 드로어 폴링을 위한 현재 수동 백업/복원 요청 상태도 반환합니다. 오래된 요청(처리되지 않았거나 진행 하트비트가 없는 요청)은 실패로 표시되므로 UI에서 항상 새 요청을 제출할 수 있습니다.

매개변수

club `string` (필수) uuid `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-snapshots/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-snapshots/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지금 AI 에이전트 수동 백업 요청

수동 실행 요청(사용자 메모 포함)을 등록 행에 기록하고 MQTT로 기기에 알림을 보냅니다. 기기는 JWT 인증 universal-api 실행 컨텍스트 호출을 통해 검증된 요청을 가져오며, MQTT가 없어도 다음 스케줄러 주기에 요청을 처리합니다. 다른 백업 또는 복원이 진행 중이면 거부됩니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/backup-run/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-run/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI 에이전트 복원 지점 고정 또는 고정 해제

고정된 복원 지점은 보존 정책에 따른 정리에서 보호됩니다. 기기의 야간 유지 관리 작업이 실행 컨텍스트 호출을 통해 고정된 스냅샷 ID를 받아 restic forget에서 제외하며, 해당 인덱스 행은 TTL로 만료되지 않습니다. 고정을 해제하면 일반 보존 동작으로 돌아갑니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/backup-pin/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-pin/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

백업 복원 지점에서 AI 에이전트 복원

복원 요청을 등록 행에 기록하고 기기에 알림을 보냅니다. 전체 복원은 /data 및 /home/hermeswebui를 덮어쓰며(기기는 먼저 복원 전 안전 스냅샷을 자동으로 생성하고 복원 중에는 에이전트를 중지합니다), 확인을 위해 기기 이름을 입력해야 합니다. `paths`를 전달하면 대신 해당 경로만 중단 없이 파일 단위로 복원합니다. 선택적으로 데이터 복원이 완료되면 기기를 스냅샷의 소프트웨어 릴리스로 다시 고정합니다(backup-restore-release 참조).

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/backup-restore/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-restore/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

완료된 복원에 기록된 소프트웨어 릴리스 적용

스냅샷의 소프트웨어 버전을 요청한 복원의 마지막 단계입니다. 기기가 데이터 복원 완료를 보고하면 저장된 릴리스로 기기를 고정하고 업데이트 잠금을 해제합니다(업데이트 엔드포인트와 동일한 방식). 드로어의 폴링으로 실행되며 멱등적입니다. 적용된 후에는 저장된 고정 정보가 지워집니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/backup-restore-release/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-restore-release/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

백업 복원 지점 내 파일 탐색

restic 스냅샷의 디렉터리 한 단계를 나열하며, 전적으로 서버 측에서 Wasabi 저장소로부터 제공됩니다(기기가 오프라인이어도 작동합니다). 트리 메타데이터만 읽으며, 목록 조회 시 파일 데이터는 다운로드하지 않습니다.

매개변수

club `string` (필수) uuid `string` (필수) takenAt `number` (필수) path `string` (선택)

엔드포인트

GET /api/devices/ph-ai-agent/backup-files/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-files/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

백업 복원 지점 내 파일 이름 검색

디렉터리부터 하위로 대소문자를 구분하지 않고 파일 이름을 검색하며, restic 트리 메타데이터를 사용해 서버 측에서 제공합니다(파일 데이터는 읽지 않으며 기기가 오프라인이어도 작동합니다). 목록을 스트리밍하며 처음 200개 일치 항목에서 중지합니다.

매개변수

club `string` (필수) uuid `string` (필수) takenAt `number` (필수) q `string` (필수) path `string` (선택)

엔드포인트

GET /api/devices/ph-ai-agent/backup-search/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-search/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

두 백업 복원 지점 간 변경 사항

기기의 두 스냅샷 간에 서버 측 restic diff를 실행하고(트리 메타데이터만 사용) 추가/제거/수정된 파일 목록(최대 500개 변경)과 요약 통계를 반환합니다. 스냅샷은 변경되지 않으므로 결과는 캐시됩니다.

매개변수

club `string` (필수) uuid `string` (필수) fromTakenAt `number` (필수) toTakenAt `number` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-diff/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-diff/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 복원 지점에 걸친 파일 하나의 버전 기록

기기 저장소의 모든 스냅샷에 대해 서버 측 restic find를 한 번 실행하여 고유한 버전으로 축약하고(연속으로 동일한 크기+mtime 결과는 병합됩니다) 날짜/종류/메모를 위해 스냅샷 인덱스 행과 결합합니다.

매개변수

club `string` (필수) uuid `string` (필수) path `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-file-versions/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-file-versions/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

파일 이름으로 기기 백업의 모든 복원 지점 검색

삭제된 파일 복구 경로입니다. 저장소의 모든 스냅샷에 대해 서버 측 restic find를 한 번 실행하고(대소문자 구분 없음, 부분 문자열 또는 glob), 각 파일이 포함된 복원 지점과 함께 경로별로 그룹화합니다. 기기에서 삭제된 파일이라도 해당 파일이 포함된 복원 지점이 있는 한 여기에서 찾을 수 있습니다.

매개변수

club `string` (필수) uuid `string` (필수) q `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-find/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-find/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

백업 복원 지점에서 단일 파일 다운로드

restic 저장소에서 파일 하나를 브라우저로 바로 스트리밍합니다(첨부 파일). 디렉터리는 tar 아카이브로 스트리밍됩니다. 크기 제한이 있으며 서버 측에서 제공되므로 기기가 오프라인이어도 작동합니다.

매개변수

club `string` (필수) uuid `string` (필수) takenAt `number` (필수) path `string` (필수)

엔드포인트

GET /api/devices/ph-ai-agent/backup-file-download/{club}/{uuid}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-file-download/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에서 AI 에이전트 해제

매개변수

club `string` (필수)

엔드포인트

POST /api/devices/ph-ai-agent/decommission/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/decommission/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에서 AI 에이전트를 제거하고 하드웨어를 공장 초기화

기기를 완전히 연결 해제하여 어느 시설에서든 페어링할 수 있도록 하고 NUC의 모든 데이터를 삭제합니다. 삭제는 클라우드 해제 전에 PH_FACTORY_RESET balena 기기 변수(일회용 nonce)로 예약되므로, 제거 시점에 기기가 오프라인이어도 유지되며 기기가 다음에 연결될 때 실행됩니다. 온라인 상태인 경우 MQTT factoryReset 알림으로 즉시 실행됩니다. 이어서 클라우드 해제 과정에서 모든 자격 증명과 권한 부여를 취소하고, Balena 시설 바인딩(기기 변수 + club 태그)과 메타데이터 clubID를 지우며, 접근 요청과 LAN DNS 레코드를 삭제합니다. 클라우드 백업은 보존됩니다. 스냅샷 인덱스와 저장소 비밀번호는 소프트 삭제된 등록에 남아 있어 교체 기기를 추가할 때 복원 소스로 사용할 수 있습니다. 확인을 위해 기기 이름을 입력해야 합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/reset/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/reset/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

고장 난 AI 에이전트를 새 NUC로 교체(재해 복구)

한 번에 기기를 교체합니다. 교체용 NUC를 연결하고(터널 슬롯, 시크릿, balena 변수, 백업 시드), 이전 기기의 이름, 위치, 재부팅 일정, 백업 설정, 접근 차단 및 MCP 권한 부여를 이전하며, 이전 스냅샷 인덱스를 새 기기로 다시 연결하고(전체 백업 기록을 계속 탐색할 수 있음), 이전 등록을 해제한 뒤(replacedBy / replacedFrom 기록), `restore`가 false가 아닌 한 이전 기기의 백업 저장소에서 선택한 복원 지점의 전체 복원을 새 하드웨어에 대기열로 추가합니다. 이전 기기가 고장 나거나 오프라인이어도 작동하며, 확인을 위해 이전 기기의 이름을 입력해야 합니다. 같은 시설 내에서만 가능합니다.

매개변수

club `string` (필수)

요청 본문

엔드포인트

POST /api/devices/ph-ai-agent/replace/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/replace/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Performance Hub 기기 QR 단축 링크를 해당 딥 링크로 확인하여 기기 추가 스캐너가 기기 유형을 감지할 수 있도록 합니다. performancehub.co 호스트만 따라갑니다.

매개변수

url `string` (필수) 스캔한 단축 링크

엔드포인트

GET /api/devices/resolve-qr

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/resolve-qr \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Unifi Controller 연결 상태와 자격 증명이 올바른지 테스트합니다.

매개변수

facilityID `string` (필수) Unifi 연결을 테스트할 시설의 내부 ID

엔드포인트

GET /api/devices/testUnifiController/{facilityID}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/devices/testUnifiController/{facilityID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

일반 IoT 기기를 시설과 연결하여 업데이트합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

PUT /api/devices/updateGenericDevice/{club}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/devices/updateGenericDevice/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 및 사용자와 연결된 클럽을 기준으로, 처리되지 않아 조치가 필요한 계약 수를 나열합니다

엔드포인트

GET /api/agreements/agreements-outstanding

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agreements/agreements-outstanding \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽에서 사용할 수 있는 모든 계약을 나열합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. contracts-sort `string` (선택) 계약을 시행일순 또는 알파벳순으로 정렬합니다. 기본값은 시행일순입니다. contracts-acknowledgement `string` (선택) 계약을 전체, 확인됨 또는 미확인으로 필터링합니다. 기본값은 전체입니다. contracts-requirement `string` (선택) 계약을 전체, 서명, 체크박스, 팝업 또는 없음으로 필터링합니다. 기본값은 전체입니다. contracts-status `string` (선택) 계약을 전체, 활성 또는 보관됨으로 필터링합니다. 기본값은 전체입니다.

엔드포인트

GET /api/agreements/list-agreements/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/agreements/list-agreements/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

ID를 기준으로 계약에 서명합니다.

매개변수

club `string` (필수) 계약에 서명하는 클럽의 내부 ID입니다. agreementid `string` (필수) 서명할 계약의 ID입니다. body `string` (필수) 시스템에 추가/업로드할 계약과 매개변수가 포함된 JSON 객체입니다.

엔드포인트

POST /api/agreements/sign/{club}/{agreementid}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/agreements/sign/{club}/{agreementid} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 Model Router 요약(구성, 잔액, 지출).

매개변수

clubID `string` (필수) tz `string` (선택) 뷰어의 IANA 시간대입니다. 시설에 시간대 데이터가 없을 때 일별/월별 지출 기간에 대신 사용됩니다.

엔드포인트

GET /api/clubs/{clubID}/ai-credits/overview

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/overview \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용 가능한 모델의 카탈로그와 시설별 사용 설정 상태입니다(기본값은 모두 사용).

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/models

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/models \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용 가능한 가드레일 및 PH 사전 설정 템플릿입니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/guardrails

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/guardrails \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

연결된 Model Router 서비스입니다. 페어링된 AI 에이전트 기기, 유형이 명시된 외부 에이전트 및 시설 Workflow 서비스를 포함합니다. 구성은 PATCH /keys/{keyHash}로 편집합니다.

매개변수

clubID `string` (필수) tz `string` (선택) 뷰어의 IANA 시간대입니다. 시설에 시간대 데이터가 없을 때 일별/월별 지출 기간에 대신 사용됩니다.

엔드포인트

GET /api/clubs/{clubID}/ai-credits/agents

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/agents \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에 Model Router를 사용 설정하고 추론 액세스를 프로비저닝합니다.

매개변수

clubID `string` (필수)

엔드포인트

POST /api/clubs/{clubID}/ai-credits/enable

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/enable \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

요금제, 모델 허용 목록, 가드레일, 콘텐츠 필터(PH 측 정규식 마스킹/차단), 지출 한도 및 자동 충전 구성을 업데이트합니다.

매개변수

clubID `string` (필수)

엔드포인트

PATCH /api/clubs/{clubID}/ai-credits/config

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/config \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

누적 하드 캡 카운터를 0으로 재설정하고(현재 지출을 새 기준으로 설정) 종료된 기간을 기록에 남깁니다.

매개변수

clubID `string` (필수)

엔드포인트

POST /api/clubs/{clubID}/ai-credits/spend-limit/reset-total

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/spend-limit/reset-total \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

하드 캡 재설정 기록(최신순)입니다. 종료된 기간별 한도, 지출액 및 타임스탬프를 포함합니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/spend-limit/history

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/spend-limit/history \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 새 phk_ API 키를 생성합니다(일반 텍스트는 한 번만 반환됩니다). 지출 한도, 모델 허용 목록, 가드레일, 콘텐츠 필터 및 rpmLimit/tpmLimit 속도 제한을 선택적으로 지정할 수 있습니다.

매개변수

clubID `string` (필수)

엔드포인트

POST /api/clubs/{clubID}/ai-credits/keys

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/keys \
  -H "x-api-key: YOUR_API_KEY"

편집 가능한 키 필드(레이블, 키별 지출 한도, 모델 허용 목록, 가드레일, 콘텐츠 필터 및 rpmLimit/tpmLimit 속도 제한)를 업데이트합니다(키에 동기화됨).

매개변수

clubID `string` (필수) keyHash `string` (필수)

엔드포인트

PATCH /api/clubs/{clubID}/ai-credits/keys/{keyHash}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/keys/{keyHash} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 요청별 추론 로그(실시간, 메타데이터만)입니다.

매개변수

clubID `string` (필수) page `string` (선택) pageSize `string` (선택) status `string` (선택) model `string` (선택) provider `string` (선택) source `string` (선택) `key` 또는 `agent` keyHash `string` (선택) PH keyHash로 단일 키/에이전트를 필터링합니다. q `string` (선택) 요청 ID, 키/에이전트 레이블, 모델, 공급자, 최종 사용자에 걸쳐 자유 텍스트로 검색합니다. minutes `string` (선택) 하루 미만 기간(예: Live=1440)이며 startDate/endDate보다 우선합니다. startTs `string` (선택) 기간 시작(epoch 초, 클릭하여 확대)이며 minutes/dates보다 우선합니다. endTs `string` (선택) 기간 종료(epoch 초, 클릭하여 확대)이며 minutes/dates보다 우선합니다.

엔드포인트

GET /api/clubs/{clubID}/ai-credits/logs

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/logs \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Logs 보기용 시간대별 요청 히스토그램입니다. 목록 경로와 같은 필터를 사용하지만 서버 측에서 시간 구간(성공/실패 수)으로 집계하므로 로그 양과 관계없이 응답이 매우 작습니다. 구간 크기는 기간에 맞게 자동으로 선택됩니다.

매개변수

clubID `string` (필수) status `string` (선택) model `string` (선택) provider `string` (선택) source `string` (선택) keyHash `string` (선택) q `string` (선택) minutes `string` (선택) startDate `string` (선택) endDate `string` (선택) startTs `string` (선택) endTs `string` (선택)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/logs/histogram

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/logs/histogram \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기간별 사용량 분석 구간 + 모델별 합계(실시간)입니다.

매개변수

clubID `string` (필수) range `string` (선택) 24h | 7 | 30 | 90 | year | all(startDate/endDate를 지정하면 무시됨) startDate `string` (선택) endDate `string` (선택) groupBy `string` (선택) model(기본값) | key | source | provider | status: 구간 및 그룹의 차원 subgroupBy `string` (선택) 각 그룹 아래에 중첩되는 선택적 두 번째 차원(Explore) keyHash `string` (선택) 상세 분석 필터: 단일 키/에이전트로 범위 지정 model `string` (선택) 상세 분석 필터: 단일 모델로 범위 지정 provider `string` (선택) source `string` (선택) compare `string` (선택) "prev"로 설정하면 groupsPrev(바로 이전의 같은 길이 기간)도 반환합니다

엔드포인트

GET /api/clubs/{clubID}/ai-credits/stats

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/stats \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

최근 1년간의 일별 활동 캘린더(GitHub 스타일, 약 53주)입니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/activity

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/activity \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

저장된 SaaS 결제 카드로 청구하여 선불 Model Router 크레딧을 추가합니다.

매개변수

clubID `string` (필수) body `object` (선택)

엔드포인트

POST /api/clubs/{clubID}/ai-credits/topup

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/topup \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

애플릿이 3DS 인증을 완료한 후 충전을 확정합니다.

매개변수

clubID `string` (필수)

엔드포인트

POST /api/clubs/{clubID}/ai-credits/topup/confirm

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/topup/confirm \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

충전/자동 충전 시 청구되는 저장된 SaaS 결제 카드의 요약입니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/payment-method

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/payment-method \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 원장 거래 내역(최신순)입니다. 유형별로 필터링할 수 있습니다(예: 자금 이동 내역은 `types=topup,adjustment`, 한 달의 사용량 차감 내역은 `from`/`to`와 함께 `types=charge-reconcile`).

매개변수

clubID `string` (필수) limit `integer` (선택) 최대 행 수(기본값 50, 최대 200) types `string` (선택) 쉼표로 구분한 거래 유형(topup, charge-reconcile, refund, adjustment, trueup-shortfall) from `integer` (선택) createdAt >= from(unix 초)인 거래만 to `integer` (선택) createdAt <= to(unix 초)인 거래만

엔드포인트

GET /api/clubs/{clubID}/ai-credits/transactions

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

요청한 유형의 거래가 하나 이상 있는 고유한 `YYYY-MM` 월(UTC, 최신순)입니다. 데이터 기반 연/월 필터 드롭다운에 사용되어 UI에 실제로 데이터가 있는 기간만 표시됩니다.

매개변수

clubID `string` (필수) types `string` (선택) 쉼표로 구분한 거래 유형(topup, charge-reconcile, refund, adjustment, trueup-shortfall)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/transactions/available-periods

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions/available-periods \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

단일 Model Router 거래의 브랜드 PDF 결제 영수증입니다.

매개변수

clubID `string` (필수) txId `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/transactions/{txId}/receipt.pdf

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions/{txId}/receipt.pdf \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

선택한 충전 거래의 브랜드 PDF 결제 영수증 묶음(ZIP)입니다. 모든 ID는 해당 시설에 속한 충전 거래여야 합니다. 사용량 차감과 관리자 조정에는 영수증이 없으므로 거부됩니다.

매개변수

clubID `string` (필수) ids `string` (필수) 쉼표로 구분한 거래 ID(최대 50개)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/transactions/receipts.zip

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions/receipts.zip \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 사용량 차감을 역월(UTC)별로 집계한 내역(최신순)입니다. 이번 달은 항상 포함되며 `isCurrentMonth`(월초부터 현재까지)로 표시됩니다.

매개변수

clubID `string` (필수) months `integer` (선택) 조회 기간(개월, 기본값 12, 최대 24, `year`를 설정하면 무시됨) year `integer` (선택) 집계 범위를 UTC 기준 한 해로 지정(예: 2026)

엔드포인트

GET /api/clubs/{clubID}/ai-credits/usage-statements

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage-statements \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

브랜드 월간 사용량 명세서 PDF로, 해당 월의 사용량 차감 요약(일별 소계 + 합계)입니다. 인보이스나 영수증이 아니며, 사용량 차감으로는 결제가 이루어지지 않습니다.

매개변수

clubID `string` (필수) month `string` (필수) UTC 기준 월, `YYYY-MM`

엔드포인트

GET /api/clubs/{clubID}/ai-credits/usage-statements/{month}/statement.pdf

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage-statements/{month}/statement.pdf \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

한 달의 원시 사용량 차감 항목을 CSV로 제공합니다(거래 ID, UTC 타임스탬프, 금액, 차감 후 잔액, 누적 지출 스냅숏). 해당 월 명세서 합계와 대조할 수 있는 상세 내보내기입니다.

매개변수

clubID `string` (필수) month `string` (필수) UTC 기준 월, `YYYY-MM`

엔드포인트

GET /api/clubs/{clubID}/ai-credits/usage-statements/{month}/detail.csv

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage-statements/{month}/detail.csv \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 사용량/지출 요약(실시간 데이터 및 조정된 원장)입니다.

매개변수

clubID `string` (필수) tz `string` (선택) 뷰어의 IANA 시간대입니다. 시설에 시간대 데이터가 없을 때 일별/월별 지출 기간에 대신 사용됩니다.

엔드포인트

GET /api/clubs/{clubID}/ai-credits/usage

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI Edge Processor 기기를 클럽에 연결/업데이트합니다

매개변수

body `string` (필수) AI Edge Processor 기기 등록을 업데이트하기 위한 JSON 객체입니다.

엔드포인트

POST /api/ai-edge-processor/devices

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ai-edge-processor/devices \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

AI Edge Processor 기기를 클럽에 연결합니다. 메타데이터를 우선하여 기기를 확인하고(실시간 하트비트 우선), 기기가 자체 등록한 적이 없으면 등록 행을 보완하며, 다시 프로비저닝된 하드웨어가 남긴 오래된 등록 행을 정리합니다.

매개변수

body `string` (필수) AI Edge Processor 기기 등록을 업데이트하기 위한 JSON 객체입니다.

엔드포인트

POST /api/ai-edge-processor/devices/associate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ai-edge-processor/devices/associate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 bbox 업로드 기록 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/bbox-timeline/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/bbox-timeline/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

카메라 데이터베이스 검색 색인

네트워크 카메라를 추가할 때 Find my camera 대화 상자에서 사용하는 공개 문서 camera-db 검색 색인(제조사, 시리즈, 모델, 별칭)을 프록시합니다. 서버 측에서 12시간 동안 캐시됩니다.

엔드포인트

GET /api/cctv/camera-db/search-index

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/camera-db/search-index \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

카메라 데이터베이스 제조사 템플릿

공개 문서 카메라 데이터베이스에서 단일 제조사의 RTSP URL 템플릿과 기본값을 프록시합니다. 경로 탐색을 방지하기 위해 슬러그를 검증합니다. 서버 측에서 12시간 동안 캐시됩니다.

매개변수

slug `string` (필수) 제조사 슬러그(예: hikvision)

엔드포인트

GET /api/cctv/camera-db/manufacturers/{slug}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/camera-db/manufacturers/{slug} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 체크인 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽/시설의 내부 ID입니다. startDate `string` (선택) YYYY-MM-DD 형식의 시작 날짜 endDate `string` (선택) YYYY-MM-DD 형식의 종료 날짜 timezone `string` (선택) 날짜 해석에 사용할 시간대(기본값 Australia/Brisbane) nextToken `string` (선택) 다음 페이지를 가져오기 위한 페이지 매김 토큰

엔드포인트

GET /api/cctv/check-ins/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/check-ins/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 프런트엔드 또는 UI 구성 조회

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/config/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/config/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 콘텐츠 전송 구성 가져오기

CCTV 클라이언트가 미디어 에셋을 확인하는 데 사용하는 콘텐츠 도메인을 반환합니다. 도메인은 CONTENT_DOMAIN 환경 변수로 결정되며, 없으면 단계별 기본값(프로덕션은 /cctv, 다른 단계는 /cctv-stg)이 사용됩니다.

엔드포인트

GET /api/cctv/content-config

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/content-config \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 프런트엔드 또는 UI 구성 변경

매개변수

body `object` (필수) 시스템에 추가할 새 구성 블록의 JSON 객체입니다.

엔드포인트

PUT /api/cctv/config/:club/:section

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/cctv/config/:club/:section \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 스토리지 공급자 구성에 사용할 수 있는 버킷 리전 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/bucket-region/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/bucket-region/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

미확인 얼굴 컬렉션 재설정

모든 대상을 삭제하여 시설의 미확인 CompreFace 컬렉션을 재설정합니다. DynamoDB 인물 기록, 얼굴 감지 및 OpenSearch 타임라인 블록에는 영향을 주지 않습니다. 기본 얼굴 인식 데이터만 지워집니다. 시스템이 새 카메라 감지를 처리하면 새 섀도 프로필이 자동으로 생성됩니다.

매개변수

facilityId `string` (필수)

엔드포인트

DELETE /api/cctv/config/{facilityId}/unidentified-collection

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/config/{facilityId}/unidentified-collection \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

미확인 컬렉션 정보 가져오기

시설의 미확인 CompreFace 컬렉션에 있는 현재 대상 수를 반환합니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/cctv/config/{facilityId}/unidentified-collection-info

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/config/{facilityId}/unidentified-collection-info \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

스트림 URL(RTSP, HTTP, HTTPS)로 네트워크 카메라(OEM/IP 카메라)를 추가합니다

매개변수

body `string` (필수) 네트워크 카메라를 추가하기 위한 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices/add-network-camera

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/add-network-camera \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Edge Processor에 네트워크 카메라 일괄 추가

여러 RTSP/HTTP 네트워크 카메라를 하나의 Edge Processor에 등록한 다음 FEED_CONFIG를 한 번 푸시하여 기기가 구성을 한 번만 다시 로드하도록 합니다.

매개변수

body `object` (필수)

엔드포인트

POST /api/cctv/devices/add-network-cameras

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/add-network-cameras \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기를 클럽에 연결/업데이트합니다

매개변수

body `string` (필수) CCTV 기기 등록을 업데이트하기 위한 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기를 클럽에 연결합니다

매개변수

body `string` (필수) CCTV 기기 등록을 업데이트하기 위한 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices/associate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/associate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 기기 UUID로 MQTT 요청을 보내고, 카메라에서 사용 가능한 기능에 대한 응답을 (웹소켓을 통해) 기다립니다.

매개변수

club `string` (필수) 조회하는 기기를 소유한 클럽의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices/list-camera-capabilities/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/list-camera-capabilities/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기 등록 나열

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/devices/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/devices/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

네트워크 카메라를 삭제됨으로 표시하고 Edge Processor FEED_CONFIG에서 제거합니다

매개변수

club `string` (필수) 기기를 소유한 클럽의 내부 ID입니다. balenaUUID `string` (필수) 제거할 네트워크 카메라의 UUID입니다.

엔드포인트

DELETE /api/cctv/devices/remove-network-camera/{club}/{balenaUUID}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/devices/remove-network-camera/{club}/{balenaUUID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

구성된 카메라 기능을 저장하고 (balena를 통해) 기기에 환경 변수로 적용합니다

매개변수

club `string` (필수) 조회하는 기기를 소유한 클럽의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices/save-camera-capabilities/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/save-camera-capabilities/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

카메라의 모션 마스크(구성된 경우)를 저장하고 (balena를 통해) 기기에 환경 변수로 적용합니다

매개변수

club `string` (필수) 조회하는 기기를 소유한 클럽의 내부 ID입니다. body `string` (필수) 카메라 마스크의 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices/save-camera-mask/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/save-camera-mask/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 v4l2 명령(밝기, 대비 등)을 물리적 기기에 보냅니다

매개변수

club `string` (필수) 조회하는 기기를 소유한 클럽의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/cctv/devices/set-camera-capability/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/set-camera-capability/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

네트워크 카메라 스트림 URL 테스트

Edge Processor에 테스트 명령을 보내 ffprobe로 카메라 스트림 URL을 검증합니다

요청 본문

엔드포인트

POST /api/cctv/devices/test-stream

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/test-stream \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

데이터베이스에서 단일 얼굴 감지 기록을 영구적으로 삭제합니다. 인물의 활동 로그에서 잘못 일치했거나 부정확한 추적 항목을 제거하는 데 사용합니다.

매개변수

club `string` (필수) fdID `string` (필수)

엔드포인트

DELETE /api/cctv/face-detections/:club/:fdID

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/face-detections/:club/:fdID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

인물의 얼굴 감지 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. personID `string` (필수) 얼굴 식별 시스템 내 인물의 ID

엔드포인트

GET /api/cctv/face-detections/:club/:personID

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections/:club/:personID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 인물 크롭 이미지를 참조하는 얼굴 감지를 personCropImage GSI로 조회하여 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. personCropImage `string` (필수) 얼굴 감지 기록에 저장된 인물 크롭 이미지 URL입니다. limit `string` (선택) 반환할 최대 감지 수입니다. nextToken `string` (선택) 이전 응답의 페이지 매김 토큰입니다.

엔드포인트

GET /api/cctv/face-detections-by-person-crop-image/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections-by-person-crop-image/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

현재 시간을 기준으로 한 기간별로 그룹화된 클럽의 얼굴 감지 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/face-detections/:club/timeline

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections/:club/timeline \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 얼굴 감지 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/face-detections/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

OpenSearch로 시설의 얼굴 감지 타임라인 블록 검색

매개변수

facilityId `string` (필수) 검색할 시설의 내부 ID timezone `string` (필수) 날짜 변환에 사용할 IANA 시간대(예: Pacific/Auckland) startDate `string` (선택) 시작 날짜 필터(YYYY-MM-DD)이며, 시간대를 사용해 startUnix로 변환됩니다 endDate `string` (선택) 종료 날짜 필터(YYYY-MM-DD)이며, 시간대를 사용해 endUnix로 변환됩니다 personId `string` (선택) 특정 인물 ID로 필터링 query `string` (선택) 자유 텍스트 검색(예: 인물 이름) limit `string` (선택) 페이지당 결과 수(기본값 20, 최대 100) filters `string` (선택) JSON으로 인코딩된 필터 객체(예: {"matchType":"identified"}) sortBy `string` (선택) 정렬 기준 필드(startUnix, endUnix, created)입니다. 기본값은 endUnix입니다. page `string` (선택) 페이지 매김용 페이지 번호(기본값 1) sortOrder `string` (선택) 정렬 방향(asc 또는 desc)입니다. 기본값은 desc입니다.

엔드포인트

GET /api/cctv/search/face-detections/timeline-blocks/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/search/face-detections/timeline-blocks/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 시설에 관한 보고서 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/facility/:club/reports

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/facility/:club/reports \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

필요할 때 히트맵 생성을 트리거합니다. 예약된 cron이 사용하는 것과 같은 Starter 로직을 호출하지만, 특정 시설, 날짜/시간 및 기간 집합을 대상으로 지정할 수 있습니다. 본문 없이 호출하면 cron과 똑같이 동작하여, 대상이 되는 모든 시설을 검사하고 모든 기기를 대기열에 추가합니다.

요청 본문

엔드포인트

POST /api/cctv/heatmaps/generate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/heatmaps/generate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

단일 기기에 대해 합성된 롤링 기간 히트맵 PNG의 위치를 확인합니다. JSON 메타데이터만 반환합니다. PNG 바이트는 콘텐츠 도메인에 있으며, 프런트엔드는 다음과 같이 URL을 구성합니다. `${contentDomain}/cctv/${storageService}/${region}/${filePath}?s=${token}` 확인 순서: 1. DynamoDB `composed#…` 색인 적중 → 즉시 반환(약 10 ms). 2. 결정적 캐시 키에 대한 Wasabi HEAD. 적중하면 보완 색인 행을 기록하고 반환합니다. 3. 오래된 데이터 대체: 날짜가 다르더라도 이 (기기, 기간, 시간) 조합에 대한 합성 기록이 있는 경우입니다. FE가 *무언가*를 표시할 수 있도록 `cache: 'HIT-STALE'`와 함께 즉시 반환됩니다. 새 합성은 비동기로 실행됩니다. 4. 콜드 경로: 기록이 전혀 없는 경우입니다. 합성 Lambda가 `InvocationType: 'Event'`로 대기열에 추가되고 엔드포인트는 `202 { cache: 'PENDING' }`를 반환합니다. FE는 기록이 생성될 때까지 폴링합니다(일반적으로 3~5초). 오늘 날짜 처리: `endDate`가 시설 현지 기준 "오늘"이면 엔드포인트는 대신 어제의 PNG를 제공합니다. 오늘의 슬라이스는 아직 Starter cron이 기록 중이므로 새로 합성하면 불완전하기 때문입니다. 응답에는 요청한 `endDate`가 그대로 포함되며 `endDateUsed`(= 어제)도 포함됩니다. `cache` 열거형: - `HIT`: 요청한 날짜에 대해 DDB 색인에서 제공됨. - `HIT-FALLBACK`: 오늘 날짜를 요청하여 어제의 색인 행이 제공됨. - `HIT-BACKFILL`: DDB에는 없지만 Wasabi에 PNG가 있었으며, 행이 방금 기록됨. - `HIT-FALLBACK-BACKFILL`: 어제 날짜 대체에 대한 보완. - `HIT-STALE`: 요청한 날짜의 기록은 없지만 이 조합에 대해 다른 날짜의 기록이 있음. 즉시 제공되며 백그라운드에서 새 합성이 대기열에 추가됨. - `PENDING`: 기록이 전혀 없으며 합성이 대기열에 추가됨. FE는 폴링해야 함. 응답은 `202 Accepted`이며 `filePath`는 없음.

매개변수

facilityId `string` (필수) deviceUUID `string` (필수) 합성할 기기입니다. 합성은 기기별로 이루어집니다. hour `integer` (필수) 조회 기간 전체에 걸쳐 합성할 시간(0–23)입니다. endDate `string` (선택) 기간의 마지막 날짜(YYYY-MM-DD)입니다. 기본값은 오늘(시설 시간대 기준)입니다. range `string` (선택) 조회 기간입니다. 허용된 범위 중 하나여야 합니다. nocache `integer` (선택) `1`로 설정하면 DDB + HEAD 캐시 계층을 건너뛰고 강제로 새로 합성합니다.

엔드포인트

GET /api/cctv/heatmaps/hourly/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/heatmaps/hourly/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

롤링 조회 기간 동안 기기에 `1h` 슬라이스 기록이 있는 시간대를 확인합니다. 프런트엔드는 합성 엔드포인트(`/api/cctv/heatmaps/hourly/...`)를 호출하기 전에 이 결과로 날짜 + 기간 선택기와 함께 시간 선택기를 채웁니다. 예시: `GET /api/cctv/heatmaps/query-hourly/Birkdale?deviceUUID=abc123&endDate=2026-04-16&range=30d` 내부적으로는 `cctvheatmaps`에 대해 DynamoDB 범위 쿼리 한 번 (`sk BETWEEN 1h#{start}-00 AND 1h#{end}-23`)을 실행하고 시간별로 그룹화합니다. 슬라이스가 하나 이상 있는 시간마다 항목 하나를 반환하며, 대표 참조 JPEG(기간 중 가장 최근 날짜에서 가져옴, 참조는 기기별·일별로 공유됨)를 포함합니다.

매개변수

facilityId `string` (필수) deviceUUID `string` (필수) 조회할 기기입니다. 시간별 슬라이스는 기기별로 존재합니다. endDate `string` (선택) 기간의 마지막 날짜(YYYY-MM-DD)입니다. 기본값은 오늘(시설 시간대 기준)입니다. range `string` (선택) 조회 기간입니다. 허용된 범위 중 하나여야 합니다.

엔드포인트

GET /api/cctv/heatmaps/query-hourly/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/heatmaps/query-hourly/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에 대해 미리 생성된 히트맵 기록을 조회합니다. **기간 유형의 모든 기록:** - `/api/cctv/heatmaps/Birkdale?periodType=1y` - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&periodType=1d` **날짜 범위: 단일 기간 유형:** - `/api/cctv/heatmaps/Birkdale?periodType=1d&from=2026-03-01&to=2026-03-31` - `/api/cctv/heatmaps/Birkdale?periodType=6h&from=2026-03-31&to=2026-03-31` **날짜 범위: 해당하는 모든 기간 유형(periodType 생략):** - `/api/cctv/heatmaps/Birkdale?from=2026-03-01&to=2026-03-31` 지정한 범위와 겹치는 연간, 반기, 분기 등부터 6h까지의 기록을 반환합니다. **특정 시점: 기기 하나의 9개 기간 유형 전체:** - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&date=2026-03-15T14:30` 최대 9개의 기록(1y, 6m, 3m, 2m, 1m, 1w, 1d, 12h, 6h)을 반환합니다.

매개변수

facilityId `string` (필수) 시설 식별자입니다. deviceUUID `string` (선택) 특정 기기를 조회합니다. 생략하면 모든 기기에 걸쳐 조회합니다(GSI). periodType `string` (선택) 단일 기간 유형으로 필터링합니다. from/to와 함께 생략하면 모든 유형을 조회합니다. from `string` (선택) 시작 날짜(yyyy-mm-dd)입니다. `to`와 함께 사용해야 합니다. to `string` (선택) 종료 날짜(yyyy-mm-dd)입니다. `from`과 함께 사용해야 합니다. date `string` (선택) 특정 시점 조회(yyyy-mm-dd 또는 yyyy-mm-ddTHH:mm)입니다. deviceUUID가 필요합니다. 기간 유형마다 기록 하나를 반환합니다.

엔드포인트

GET /api/cctv/heatmaps/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/heatmaps/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기 라이브 스트림 썸네일 가져오기

매개변수

club `string` (필수) 클럽의 내부 ID입니다. deviceId `string` (필수) CCTV 기기의 내부 ID입니다.

엔드포인트

GET /api/cctv/livestream/:club/thumbnail/:deviceId

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/livestream/:club/thumbnail/:deviceId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

라이브 스트림을 시청할 것임을 CCTV 시스템에 알립니다

매개변수

club `string` (필수) 클럽의 내부 ID입니다. deviceId `string` (필수) CCTV 기기의 내부 ID입니다.

엔드포인트

POST /api/cctv/livestream/:club/iswatching/:deviceId

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/livestream/:club/iswatching/:deviceId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

교차 일치 승인

일치 상태를 확인됨으로 설정하고 검토자를 기록합니다.

매개변수

club `string` (필수) matchId `string` (필수)

엔드포인트

POST /api/cctv/matching/{club}/detail/{matchId}/approve

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/approve \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

방문 세부 정보가 포함된 단일 교차 일치 가져오기

일치 기록과 방문별 시간 분석을 반환합니다.

매개변수

club `string` (필수) matchId `string` (필수)

엔드포인트

GET /api/cctv/matching/{club}/detail/{matchId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

일치하지 않은 인물을 회원에 수동으로 연결

CCTV personId를 특정 회원과 연결하고 일치를 확인됨으로 설정합니다.

매개변수

club `string` (필수) matchId `string` (필수)

요청 본문

엔드포인트

POST /api/cctv/matching/{club}/detail/{matchId}/link

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/link \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 교차 일치 나열

상태별로 필터링된 일치 항목을 페이지 단위로 반환합니다.

매개변수

club `string` (필수) status `string` (선택) limit `integer` (선택) nextToken `string` (선택)

엔드포인트

GET /api/cctv/matching/{club}/list

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/matching/{club}/list \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

교차 일치 거부

일치 상태를 거부됨으로 설정하고 검토자를 기록합니다.

매개변수

club `string` (필수) matchId `string` (필수)

엔드포인트

POST /api/cctv/matching/{club}/detail/{matchId}/reject

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/reject \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

교차 일치 요약 개수 가져오기

시설의 일치 개수를 상태별로 그룹화하여 반환합니다.

매개변수

club `string` (필수) 시설 ID

엔드포인트

GET /api/cctv/matching/{club}/summary

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/matching/{club}/summary \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

자동 학습된 프로필 일치 연결 해제

연결된 일치를 거부됨 상태로 되돌리고 회원 기록의 autoLearnedFrom을 지웁니다.

매개변수

club `string` (필수) matchId `string` (필수)

요청 본문

엔드포인트

POST /api/cctv/matching/{club}/detail/{matchId}/unlink

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/unlink \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

진행 중인 "식별된 인물 업서트" 작업(생성 및 편집 포함)의 상태를 읽습니다. Lambda를 거치지 않고 cctv-rekognition-api가 소유한 `people-ops` 테이블에서 행을 직접 읽습니다. CCTV 프런트엔드가 POST /api/cctv/people/{facility}/identified 이후 진행 상황을 폴링하는 데 사용합니다. 이 경로는 `/cctv/people/...`의 하위가 아닌 같은 수준에 있으므로, express 라우터가 `/cctv/people/:club/:personID`에서 `operationId`를 `:personID`로 잘못 일치시킬 수 없습니다. createAPIRouter glob 순서를 참조하십시오. upsertIdentifiedPerson Lambda가 아직 첫 번째 단계 항목을 기록하지 않은 동안(콜드 스타트 구간)에는 `pending` 자리 표시자를 반환합니다. FE 폴링 훅은 자리 표시자와 pending을 동일하게 처리하므로 호출자에게 계약이 안정적으로 유지됩니다.

매개변수

operationId `string` (필수)

엔드포인트

GET /api/cctv/people-operations/{operationId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people-operations/{operationId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

(기존 추적 감지의) 얼굴 이미지를 인물의 CompreFace 인식 대상에 추가하고 섀도 사진 테이블에 참조를 저장합니다. 이미지는 이미 얼굴 감지 캡처로 Wasabi에 있으므로 Wasabi에 업로드하지 않습니다.

매개변수

club `string` (필수) personID `string` (필수) body `string` (필수)

엔드포인트

POST /api/cctv/people/:club/:personID/add-face

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/:personID/add-face \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

인물 기록에 섀도 사진 추가

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. personID `string` (필수) 인물의 기록 ID body `string` (필수) 시스템에 추가할 새 구성 블록의 JSON 객체입니다.

엔드포인트

POST /api/cctv/people/:club/shadow-photos/:personID

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/shadow-photos/:personID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

인물의 섀도 사진 조회

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. personID `string` (필수) 인물의 기록 ID

엔드포인트

GET /api/cctv/people/:club/shadow-photos/:personID

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club/shadow-photos/:personID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTVShadowPhotosTable에서 섀도 사진 기록을 영구적으로 제거하고, CompreFace에서 해당 얼굴을 제거합니다(faceId가 저장된 경우).

매개변수

club `string` (필수) personID `string` (필수) id `string` (필수) 섀도 사진 기록 ID(기본 키)

엔드포인트

DELETE /api/cctv/people/:club/shadow-photos/:personID/:id

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/people/:club/shadow-photos/:personID/:id \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

personID로 참조 및 연결된 rekognition 기록을 삭제합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. personID `string` (필수) CCTV 인물의 고유 ID입니다.

엔드포인트

DELETE /api/cctv/people/:club/:personID

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/people/:club/:personID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 인물 기록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. personID `string` (필수) 인물의 DB ID입니다.

엔드포인트

GET /api/cctv/people/:club/:personID

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club/:personID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

인물의 회원 프로필과 일치하는 출입 구역 가져오기

인물의 회원 유형, 태그 및 회원권 플랜을 확인한 다음, 포함/제외 규칙과 일치하는 실제 출입 구역(origin=membership-plan, 흡수되지 않음)을 반환합니다. 각 구역의 accessRestriction은 해당 인물과 일치한 규칙만 남도록 정리됩니다. 하위 구역 카메라는 상위 구역에 병합됩니다.

매개변수

club `string` (필수) 시설의 내부 ID personID `string` (필수) CCTV 인물 테이블의 인물 ID

엔드포인트

GET /api/cctv/people/{club}/{personID}/allowed-zones

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/{club}/{personID}/allowed-zones \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

소스별 결과를 포함한 병합 작업의 현재 상태를 반환합니다. 상태가 IN_PROGRESS인 동안 이 엔드포인트를 3~5초마다 폴링하십시오.

매개변수

club `string` (필수) mergeJobID `string` (필수)

엔드포인트

GET /api/cctv/people/:club/merge-status/:mergeJobID

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club/merge-status/:mergeJobID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

여러 미확인 인물 프로필을 하나의 유지 프로필로 병합하는 작업을 백그라운드에서 시작합니다. mergeJobID와 함께 즉시 202로 응답합니다. 진행 상황은 /merge-status/:mergeJobID를 폴링하여 확인하십시오.

매개변수

club `string` (필수) body `string` (필수)

엔드포인트

POST /api/cctv/people/:club/merge-unidentified

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/merge-unidentified \
  -H "x-api-key: YOUR_API_KEY"

시설의 차단 목록 컬렉션에 얼굴 추가

매개변수

facilityId `string` (필수) 시설의 내부 ID

요청 본문

엔드포인트

POST /api/cctv/people/{facilityId}/blacklist

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/{facilityId}/blacklist \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 식별된 인물을 업서트합니다. 새 기록을 생성하거나 기존 기록을 업데이트합니다. upsertIdentifiedPerson Lambda로 프록시하며, 이 Lambda는 인물 기록을 작성하고 제공된 사진을 Wasabi에 업로드한 후 CompreFace에서 얼굴을 다시 색인합니다. `isNewRecord`가 true(기본값)이면 Lambda가 생성 분기(cctvPeople.save)를 실행하며, `personID`를 제공하지 않으면 자동으로 생성됩니다. `isNewRecord`가 false이면 Lambda가 업데이트 분기(cctvPeople.update)를 실행하며, 이때 `personID`는 필수이고 기존 기록을 식별해야 합니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/cctv/people/{facilityId}/identified

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/{facilityId}/identified \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

시설의 CCTV 인물 테이블에 동기화되는 선택적 파트너 필드 집합을 업데이트합니다.

매개변수

facilityId `string` (필수) 시설의 내부 ID

요청 본문

엔드포인트

PUT /api/cctv/people/{facilityId}/sync-fields

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/cctv/people/{facilityId}/sync-fields \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

클럽의 인물 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/people/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

얼굴 이미지로 시설의 인물을 검색합니다. 업로드한 base64 이미지와 경로의 시설 ID로 cctv-rekognition-api imageFaceSearch Lambda를 호출합니다. 순위가 매겨진 일치 항목과 DeepFace 속성 요약을 반환합니다.

매개변수

club `string` (필수) 시설/클럽 ID body `string` (필수)

엔드포인트

POST /api/cctv/people/{club}/search-by-face

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/{club}/search-by-face \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

OpenSearch로 시설의 인물 검색

매개변수

facilityId `string` (필수) 검색할 시설의 내부 ID query `string` (선택) 검색어(예: 이름) page `string` (선택) 페이지 번호(기본값 1) limit `string` (선택) 페이지당 결과 수(기본값 20, 최대 100) filters `string` (선택) JSON으로 인코딩된 필터 객체(예: {"membershipStatus":"active"}) sortBy `string` (선택) 정렬 기준 필드(created, lastName, firstName, membershipUpdatedOn)입니다. 기본값은 created입니다. sortOrder `string` (선택) 정렬 방향(asc 또는 desc)입니다. 기본값은 desc입니다.

엔드포인트

GET /api/cctv/search/people/:facilityId

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/search/people/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

얼굴 감지 항목을 새 personID로 업데이트하고 rekognition 기록을 연결합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. body `string` (필수) 시스템에 추가할 새 구성 블록의 JSON 객체입니다.

엔드포인트

POST /api/cctv/people/:club/validate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/validate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 CCTV 녹화 데이터에 사용할 수 있는 모든 필터 객체를 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/recordings/filters/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/filters/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

녹화를 스트리밍합니다.

엔드포인트

GET /api/cctv/recordings/:club/:dir/:filename

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club/:dir/:filename \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

녹화 정보를 업데이트합니다.

엔드포인트

PUT /api/cctv/recordings/:club/:dir/:filename

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/cctv/recordings/:club/:dir/:filename \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 CCTV 녹화 데이터 요약을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/recordings/:club/summary

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club/summary \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

현재 시간을 기준으로 한 기간에 따라 클럽의 CCTV 녹화 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/recordings/:club/timeline

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club/timeline \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 CCTV 녹화 데이터 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/recordings/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

녹화는 설정된 기간이 지나면 자동으로 삭제되므로, 녹화를 보존하려면 이 기능을 사용하십시오

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

POST /api/cctv/recordings/:club/:action

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/recordings/:club/:action \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

날짜 범위 내에서 시설의 보고서 스냅숏 검색

매개변수

facilityId `string` (필수) 시설의 내부 ID startDate `string` (필수) 시작 날짜 필터(YYYY-MM-DD) endDate `string` (필수) 종료 날짜 필터(YYYY-MM-DD) deviceIds `string` (선택) 필터링할 카메라/기기 ID의 쉼표 구분 목록 view `string` (선택) 계산할 대체 보고서 보기(보고서 Lambda로 전달됨)

엔드포인트

GET /api/cctv/reports/search-report-snapshots/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/reports/search-report-snapshots/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 색인된 CCTV 미디어를 대상으로 벡터 검색을 수행합니다. searchAnything Lambda에서 전달되는 text/event-stream으로 응답하므로, 콜드 컨테이너가 인코더를 로드하는 동안 클라이언트가 진행 상황을 표시할 수 있습니다. 이벤트는 `status`가 먼저 전송되고 이어서 `result` 또는 `error`가 전송됩니다. 요청 방법은 세 가지이며, 그중 두 가지가 이 메서드에 해당합니다. 자유 텍스트로 검색하려면 `query`를 보내십시오. 예시로 검색하려면("이와 비슷한 항목") `seedIndex` + `seedKey`를 보내십시오. 이미 색인에 있는 행의 벡터를 사용하며, 사용자가 보고 있는 결과와 비슷한 항목을 더 찾는 방법입니다. 사용자가 가진 이미지로 검색하려면 대신 같은 경로로 바이트를 `POST`하십시오. 사진과 함께 단어를 보내면 서로를 통해 결과를 좁힐 수 있습니다. **텍스트는 거르고, 이미지는 순위를 정합니다.** 후보는 시드에서 나오고, 단어가 그중 남길 항목을 결정하며, 시각적 유사성이 순서를 결정합니다. 따라서 결과는 여전히 사진과 비슷하게 보이고, 단어와 일치하지 않는 항목은 제외됩니다. 두 가지는 하나의 벡터로 혼합되지 않으므로 결합 검색에서도 `queryKind`는 `similar`로 유지되며, 결과에 `query`가 있는지로 텍스트 필터가 적용되었는지 알 수 있습니다. 결합 검색은 결과가 없는 경우가 꽤 많으므로 이를 별도의 결과로 처리하십시오. `perIndex..textGated`는 사진과는 일치했지만 단어와는 일치하지 않은 후보 수이므로, 빈 페이지는 "다른 사진을 시도"가 아니라 "단어를 제거"하라는 의미로 설명할 수 있습니다. 단어가 없는 시드 검색은 인코더를 로드하지 않으므로 콜드 스타트가 발생하지 않지만, 단어를 추가하면 이 이점이 사라집니다. 어느 경우든 기본적으로 모든 색인을 검색합니다. 크롭, 녹화 및 타임랩스 벡터는 하나의 공간을 공유하므로 인물 크롭으로 일치하는 영상을 찾을 수 있습니다. 시드 점수는 텍스트 점수보다 훨씬 높게 나오며(이미지 간 비교에는 모달리티 차이가 없음), 아직 보정되지 않은 별도의 하한으로 필터링됩니다. `result.queryKind`로 어떤 척도의 점수인지 알 수 있으며, 서로 다른 척도의 점수는 절대 비교해서는 안 됩니다. 기본적으로 모든 색인을 검색하고 점수순으로 정렬된 하나의 병합 목록을 반환합니다. 각 결과에는 `index`와 `kind`가 포함되어 호출자가 이미지 결과와 동영상 결과(후자에는 `offsetMs`가 추가됨)를 구분할 수 있습니다. 시설에 테이블이 없는 색인은 실패로 처리되지 않고 `skipped`에 보고됩니다. 각 색인의 보정된 관련성 하한보다 낮은 결과는 제외되므로, 실제로 일치하는 항목이 없는 쿼리는 근거 없는 결과 대신 빈 목록을 반환합니다. `perIndex`는 각 색인이 무엇을 기여했고 그 이유가 무엇인지 보고합니다. 결과는 캡처 시간과 카메라로 좁힐 수 있습니다. `camera`보다 `cameraId`를 사용하십시오. 이는 카메라의 balenaUUID로, 모든 색인에 동일하게 저장되는 유일한 값이므로 필터 하나로 모든 색인을 좁힐 수 있습니다. 색인이 처리할 수 없는 필터는 `perIndex..filtersIgnored`에 보고되며, 해당 색인은 검색에서 제외되지 않고 필터 없이 검색됩니다. 녹화 결과는 **일치한 프레임마다가 아니라 클립마다 하나씩** 반환됩니다. 프레임은 2초마다 샘플링되므로 오래 머무는 대상은 같은 녹화에서 거의 동일한 프레임 10개와 일치하기 때문입니다. 각 클립은 가장 잘 일치하는 프레임과 함께, 클립 안에서 일치한 모든 순간을 나열하는 `matchCount`와 `offsetsMs`를 반환하며, 이 값은 탐색 지점으로 바로 사용할 수 있습니다. 한 인물의 크롭 두 개는 서로 다른 두 번의 목격이므로 인물 크롭은 하나로 합쳐지지 않습니다.

매개변수

facilityId `string` (필수) 검색할 시설의 내부 ID query `string` (선택) 찾을 대상에 대한 자유 텍스트 설명입니다. warm=1이거나 시드를 보내는 경우가 아니면 필수입니다. 시드와 함께 사용하면 순위를 정하는 대상이 아니라 시드 후보에 대한 필터가 되어, 텍스트 점수가 색인의 관련성 하한보다 낮은 후보를 제외합니다. seedIndex `string` (선택) 텍스트 대신 예시로 검색할 때 사용하며, 시드 행이 있는 색인(person-crops, recording-frames, timelapse-frames)입니다. 사용자가 클릭한 결과의 `index`입니다. seedKey와 함께 보내야 합니다. seedKey `string` (선택) 결과에서 그대로 가져온 시드 행의 `key`입니다. 시드 자체는 결과에서 제외됩니다. 녹화의 경우 다른 프레임이 2초 간격이며 거의 동일하므로 클립 전체가 제외됩니다. seedFrameId `string` (선택) seedIndex가 recording-frames인 경우 필수입니다. 이 색인은 샘플링된 프레임마다 행을 하나씩 저장하고 모든 행이 클립의 키를 공유하므로, 키만으로는 특정 순간이 아니라 클립을 가리킵니다. 결과의 `frameId`를 보내십시오. 이전 행에는 이 값이 없으므로 대신 seedOffsetMs를 보내십시오. seedOffsetMs `string` (선택) `frame_id` 도입 이전에 생성된 행을 가진 recording-frames 시드용 대체 프레임 식별자입니다. 결과의 `offsetMs`를 보내십시오. seedFrameId를 제공하면 무시됩니다. warm `string` (선택) 검색을 실행하지 않고 Lambda 컨테이너를 미리 준비합니다. 페이지를 로드할 때 호출하십시오. warmTarget `string` (선택) `warm`이 로드할 인코더로, `text`(기본값), `image` 또는 `both`입니다. 비전 타워는 355 MB로 텍스트 타워의 283 MB보다 크므로 미리 준비하려면 직접 선택해야 합니다. 페이지 로드 시가 아니라 사용자가 실제로 사진을 준비한 후에만 `image`를 요청하십시오. index `string` (선택) 검색할 데이터 세트를 쉼표로 구분하여 지정합니다(person-crops, recording-frames, timelapse-frames). 결과는 점수순으로 정렬된 하나의 목록으로 병합됩니다. 기본적으로 세 가지를 모두 검색하며, 범위를 좁히려면 목록을 명시적으로 전달하십시오. timelapse-frames는 녹화하지 않고 1분에 한 프레임만 생성하는 카메라를 다루며, 관련성 하한이 아직 보정되지 않았습니다. model `string` (선택) 쿼리에 사용할 인코더입니다. 데이터 세트를 색인한 인코더와 일치해야 합니다. limit `string` (선택) 색인별로 반환할 결과 수(기본값 50, 최대 100)입니다. 합계가 아니므로 세 색인을 모두 검색하면 최대 이 값의 세 배까지 반환될 수 있습니다. 녹화의 경우 일치한 프레임이 아니라 클립 수를 셉니다. from `string` (선택) 이 시간(epoch 이후 밀리초) 또는 그 이후에 캡처된 미디어만 일치시킵니다. 업로드 시간이 아니라 캡처 시간이라는 점에 유의하십시오. to `string` (선택) 이 시간(epoch 이후 밀리초) 이전에 캡처된 미디어만 일치시킵니다(해당 시간 제외). cameraId `string` (선택) 범위를 좁힐 카메라 balenaUUID를 쉼표로 구분하여 지정합니다. /api/cctv/recordings/filters/:club이 반환하는 각 항목의 `balenaUUID` 필드입니다. 권장되는 카메라 필터로, 모든 색인에 같은 값이 저장되므로 필터 하나로 모든 색인을 좁힐 수 있습니다. 얼굴 감지 조인이 확인된 크롭에만 이 값이 있으므로(현재 약 1%), 크롭 보완 작업이 실행될 때까지 카메라로 크롭을 좁히면 결과가 거의 없거나 전혀 없습니다. 녹화에는 값이 모두 채워져 있어 정확하게 필터링됩니다. camera `string` (선택) 범위를 좁힐 카메라 이름을 쉼표로 구분하여 지정합니다. 사실상 녹화 전용입니다. person-crops는 모든 행에 빈 카메라 이름을 저장하므로 여기에 값을 지정하면 모든 크롭이 제외됩니다. cameraId를 사용하십시오. cameraGroup `string` (선택) 범위를 좁힐 카메라 그룹을 쉼표로 구분하여 지정합니다. 모든 녹화에는 값이 있지만 크롭은 약 1%에만 있으며, 원인은 cameraId와 같습니다. minScore `string` (선택) 노이즈를 걸러 내는 색인별 코사인 하한을 재정의합니다. 프로덕션에서는 생략하십시오. 각 색인에는 보정된 기본값(및 시드 검색용으로 보정되지 않은 별도 값)이 있습니다. 관련성을 디버깅할 때 필터링되지 않은 최근접 이웃을 보려면 0을 전달하십시오.

엔드포인트

GET /api/cctv/search/anything/:facilityId

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/search/anything/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

단어나 이미 화면에 있는 결과가 아니라 사용자가 가진 이미지로 검색합니다. 그 밖의 모든 면에서 GET과 동일하므로(같은 쿼리 매개변수, 같은 이벤트 스트림, 같은 결과 형식) 여기서는 다른 점만 설명합니다. `image/*` Content-Type으로 **원본 파일 바이트**를 요청 본문에 담아 보내십시오. 먼저 브라우저에서 크기를 조정하거나 자르거나 다시 인코딩하지 마십시오. 서버는 색인된 벡터를 만들 때 사용한 매우 특정한 크기 조정 방식(안티앨리어싱 이중 선형 커널로 256x256으로 축소)을 그대로 따르지만, canvas 크기 조정은 다른 방식을 사용합니다. 측정 결과 이렇게 바뀌면 정답에서 코사인 거리가 약 0.93만큼 벗어나며, 이는 실제로 서로 다른 두 이미지보다 더 먼 거리입니다. 따라서 오류 없이 그럴듯하지만 잘못된 순위의 결과가 반환됩니다. 크기는 4 MB로 제한되며, 이는 품질이 아니라 전송상의 제약입니다. 바이트는 최대 6 MB인 Lambda 호출 페이로드에 담겨 전송되며 base64로 인해 크기가 3분의 1만큼 늘어납니다. 결과는 이미지 간 비교로 점수가 매겨지므로 `queryKind`는 `image`이고, 점수는 시드 검색과 같이 훨씬 높은 척도를 사용하므로 텍스트 점수와는 절대 비교할 수 없습니다. 동일한 시드 검색보다 점수가 약간 *낮게* 나올 수 있습니다. 시드의 벡터는 기기 자체가 기록했지만, 업로드한 이미지는 여기서 다른 엔진으로 다시 인코딩되므로 기기가 기록했을 위치에서 수백분의 몇 정도 벗어나기 때문입니다. 측정 결과 그럼에도 결과의 품질은 동일하며, 단지 완전히 같은 결과 집합이 아닐 뿐입니다. `query`를 추가하면 시드와 똑같이 해당 단어로 결과를 거릅니다. 시드*와* 이미지를 함께 보내면 거부됩니다. 둘 다 순위를 정하는 대상이므로 함께 보내는 것은 의미가 없습니다. 이 요청은 이 엔드포인트에서 가장 비용이 큰 요청입니다. 업로드한 이미지는 비전 타워를 로드하고, 단어를 추가하면 텍스트 타워도 로드하며, 둘 다 콜드 컨테이너에서 로드됩니다. 사용자가 사진을 준비하면 `warm=1&warmTarget=image`를 호출하여 이 작업을 주요 경로에서 분리하십시오.

매개변수

facilityId `string` (필수) 검색할 시설의 내부 ID body `string` (필수) 수정하지 않은 원시 이미지 바이트, 최대 4 MB query `string` (선택) 이미지 결과를 좁히는 선택적 단어로, 텍스트 점수가 색인의 관련성 하한보다 낮은 일치 항목을 제외합니다.

엔드포인트

POST /api/cctv/search/anything/:facilityId

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/search/anything/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 CCTV의 스토리지 세부 정보 및 기타 지표 데이터를 반환합니다

엔드포인트

GET /api/cctv/storage-details/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/storage-details/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 타임랩스 업로드 기록 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/timelapse/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/timelapse/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 프런트엔드 또는 UI에서 녹화에 대해 수행한 사용자 작업 나열

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/cctv/ui/actions/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/ui/actions/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 프런트엔드 또는 UI에서 녹화에 대해 수행한 사용자 작업 기록

매개변수

body `string` (필수) 시스템에 추가할 새 구성 블록의 JSON 객체입니다.

엔드포인트

POST /api/cctv/ui/actions/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/ui/actions/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CCTV 프런트엔드 또는 UI용 사용자 토큰 가져오기

매개변수

club `string` (필수) 클럽 ID

엔드포인트

GET /api/cctv/ui/token/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/ui/token/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

임시 또는 게스트 액세스용 토큰 생성

매개변수

club `string` (필수) 클럽의 고유 식별자입니다. body `string` (필수) 발급할 토큰 세부 정보의 JSON 객체입니다.

엔드포인트

POST /api/cctv/token/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/cctv/token/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{
  "accessID": "00000000-0000-0000-0000-000000000014"
}

임시 또는 게스트 액세스용 토큰 기록 목록을 반환합니다

매개변수

club `string` (필수) 클럽의 고유 식별자입니다.

엔드포인트

GET /api/cctv/token/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/cctv/token/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

접근 ID로 액세스 토큰 가져오기

매개변수

accessID `string` (필수) DB에 있는 토큰 레코드의 ID입니다.

엔드포인트

POST /guest/cctv/token/:accessID

요청 예시

curl -X POST https://portal.hub.gymsystems.co/guest/cctv/token/:accessID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 출입 시간 삭제

매개변수

facilityId `string` (필수) body `object` (필수) 새 출입 시간의 JSON 객체입니다.

엔드포인트

DELETE /api/ai/computer-vision/access-hours/:facilityId

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/ai/computer-vision/access-hours/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 출입 시간 목록을 반환합니다

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/ai/computer-vision/access-hours/:facilityId

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ai/computer-vision/access-hours/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 출입 시간을 업데이트하거나 생성합니다

매개변수

facilityId `string` (필수) body `object` (필수) 새 출입 시간의 JSON 객체입니다.

엔드포인트

POST /api/ai/computer-vision/access-hours/:facilityId

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ai/computer-vision/access-hours/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 출입 구역 삭제

매개변수

facilityId `string` (필수) body `object` (필수) 새 출입 구역의 JSON 객체입니다.

엔드포인트

DELETE /api/ai/computer-vision/access-zones/:facilityId

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/ai/computer-vision/access-zones/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 출입 구역 목록을 반환합니다

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/ai/computer-vision/access-zones/:facilityId

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ai/computer-vision/access-zones/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 출입 구역을 업데이트하거나 생성합니다

매개변수

facilityId `string` (필수) body `object` (필수) 새 출입 구역의 JSON 객체입니다.

엔드포인트

POST /api/ai/computer-vision/access-zones/:facilityId

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ai/computer-vision/access-zones/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직의 모든 브랜드와 시설에 걸친 관리자 모듈 ID의 합집합을 모듈 객체로 채워 반환합니다.

매개변수

organisationId `string` (필수) 조직 ID

엔드포인트

GET /api/organisations/{organisationId}/admin-modules

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/organisations/{organisationId}/admin-modules \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 조직 목록을 반환합니다

매개변수

includeBrands `string` (선택) 조직과 연결된 브랜드 포함 includeFacilities `string` (선택) 조직과 연결된 시설 포함 includeRegions `string` (선택) 조직과 연결된 지역 포함

엔드포인트

GET /api/organisations

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/organisations \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지원 티켓의 내용을 분석하여 사용 가능한 주제와 추천 Algolia 검색 주제를 바탕으로 제안을 생성하는 간단한 AI 도우미입니다.

매개변수

messageBody `string` (필수) 보낼 메시지의 본문 topicData `string` (필수) osTicket(티켓 관리/지원 시스템)에서 반환된 topicData의 JSON 객체/배열 facilityId `string` (선택) 검색할 올바른 Algolia 색인을 결정하는 데 필요한 클럽의 내부 ID입니다.

엔드포인트

PUT /api/ai/helpers/analyse-support-ticket

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/ai/helpers/analyse-support-ticket \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

간단한 이미지 생성 API

매개변수

type `string` (필수) 생성할 이미지 유형 name `string` (필수) 이미지 이름 maxSize `string` (선택) 선택적 최대 응답 크기입니다(예: 200KB, 1MB 또는 바이트 수). 이미지는 크기에 맞게 축소/압축됩니다.

엔드포인트

PUT /api/ai/images/:type/:name

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/ai/images/:type/:name \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

간단한 LLM 쿼리

간단한 상태 비저장 LLM 쿼리를 위한 경량 엔드포인트입니다. 엄격한 토큰 제한이 적용된 저비용 비추론 모델(gpt-4o-mini)을 사용합니다. 대화 기록, 도구, 스트리밍 없이 프롬프트를 입력하면 텍스트만 출력합니다.

요청 본문

엔드포인트

POST /api/ai/llm/query

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ai/llm/query \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

색인 이름, 앱 ID 및 API 키를 포함한 Algolia 구성을 반환합니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/facilities/{facilityId}/algolia/config

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/algolia/config \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Algolia 마케팅 인쇄물 색인을 초기화합니다

매개변수

organisationId `string` (필수)

엔드포인트

PUT /api/algolia/index

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/algolia/index \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

마케팅 인쇄물 검색

요청 본문

엔드포인트

POST /algolia/search-marketing-print

요청 예시

curl -X POST https://portal.hub.gymsystems.co/algolia/search-marketing-print \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

마케팅 인쇄물 검색

매개변수

club `string` (선택) 클럽 ID searchTerms `string` (선택) 검색어 algoliaArgs `object` (선택) 추가 Algolia 검색 인수

엔드포인트

GET /algolia/search-marketing-print

요청 예시

curl -X GET https://portal.hub.gymsystems.co/algolia/search-marketing-print \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 클럽의 마케팅 인쇄물 객체 일괄 업데이트

엔드포인트

POST /algolia/bulk-update-marketing-print

요청 예시

curl -X POST https://portal.hub.gymsystems.co/algolia/bulk-update-marketing-print \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Algolia에서 마케팅 인쇄물 에셋을 가져옵니다.

매개변수

organisationId `string` (필수) search `string` (선택) limit `string` (선택) brand `string` (선택) tag `string` (선택)

엔드포인트

GET /api/algolia/marketing/assets

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/algolia/marketing/assets \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 구성으로 Algolia 마케팅 인쇄물 색인을 초기화합니다.

매개변수

organisationId `string` (필수)

엔드포인트

POST /api/algolia/marketing/assets

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/algolia/marketing/assets \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

검색어, 클럽 및/또는 로캘을 기준으로 지정한 Algolia 색인을 검색합니다. 추가 Algolia 인수로 검색을 더 세부적으로 지정할 수 있습니다.

매개변수

searchTerms `string` (필수) Algolia 색인에서 검색할 검색어입니다. club `string` (선택) 요청하는 클럽의 내부 ID입니다. 지정하면 클럽과 연결된 지역을 기준으로 검색 결과가 필터링됩니다. locale `string` (선택) 클럽을 지정하지 않은 경우 지역을 결정하는 데 사용할 로캘입니다. navigator.languages에서 가져옵니다. algoliaArgs `string` (선택) Algolia 검색 요청에 전달할 추가/사용자 지정 인수입니다.

엔드포인트

POST /api/algolia/search-wiki

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/algolia/search-wiki \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 공지 사항을 나열합니다

엔드포인트

GET /api/announcements/list

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/announcements/list \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

에셋을 (업로드 API를 통해) 공개 S3 버킷에 업로드하며, 이후 파일 후처리/최적화, 썸네일 생성 등이 진행됩니다. *참고: 에셋은 공개적으로 사용할 수 있게 됩니다*

매개변수

file `string` (선택) 업로드할 파일/에셋의 이름입니다.

엔드포인트

POST /api/asset-upload

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/asset-upload \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 업로드 기록 UUID로 업로드 상태를 반환합니다

매개변수

uuid `string` (필수) 업로드 기록의 UUID

엔드포인트

GET /api/asset-upload/:uuid

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/asset-upload/:uuid \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 Sonos에 명령 보내기

매개변수

body `object` (필수) Sonos에 보낼 명령과 입력의 JSON 객체입니다.

엔드포인트

PUT /api/audio-control/command/:club

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/audio-control/command/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

오디오 제어 프런트엔드 구성 조회

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/audio-control/config/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/audio-control/config/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

오디오 제어 프런트엔드 구성 변경

매개변수

body `object` (필수) 시스템에 추가할 새 구성 블록의 JSON 객체입니다.

엔드포인트

PUT /api/audio-control/config/:club/:section

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/audio-control/config/:club/:section \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 지역의 브랜드 설정을 조회합니다

매개변수

brandId `string` (선택) 브랜드 ID regionCode `string` (선택) 설정을 조회할 지역의 ISO 코드

엔드포인트

GET /api/brands/{brandId}/regions/{regionCode}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/regions/{regionCode} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 지역의 여러 브랜드 설정을 업데이트합니다

매개변수

brandId `string` (선택) 업데이트할 브랜드의 ID regionCode `string` (선택) 설정을 업데이트할 지역의 ISO 코드 acceptFreeTrialBookingsVisibility `string` (선택) customTrackingCodeVisibility `string` (선택) displayDataSources `string` (선택) displayDefaultDataSource `string` (선택) displayDefaultUI `string` (선택) displayUIOptions `string` (선택) defaultAboutBusiness `string` (선택) defaultAboutBusinessFacebook `string` (선택) facilityCoverImage `string` (선택) digitalProfileSettingsVisibility `string` (선택) facilityHoursVisibility `string` (선택) facilityLocationVisibility `string` (선택) facilityPaymentMethods `string` (선택) facilityPrimaryLogo `string` (선택) facilityStatusVisibility `string` (선택) landingPagesVisibility `string` (선택) lineChatIntegrationVisibility `string` (선택) whatsAppIntegrationVisibility `string` (선택) defaultWhatsAppMessage `string` (선택) socialUrlsVisibility `string` (선택) yextApiKey `string` (선택) 이 브랜드-지역의 Yext 통합에서 사용하는 API 키입니다. `directorySyncMode`가 `yext`인 경우에만 참조됩니다. directorySyncMode `string` (선택) 이 브랜드-지역에 속한 시설에서 실행할 동기화 백엔드입니다. 값이 없으면 Directory Publishers 도입 이전 브랜드와의 하위 호환성을 위해 기본값 `yext`가 사용됩니다. websiteUrl `string` (선택) androidAppUrl `string` (선택) iosAppUrl `string` (선택) featuredMessageDescription `string` (선택) yextCategoryIds `string` (선택) 레거시 저장 키입니다. 실제로는 Google 비즈니스 프로필 카테고리 ID(예: gcid:gym)입니다. "yext" 접두사는 Yext 지원 중단 이전부터 사용된 것으로, 기존 DB 행과의 하위 호환성을 위해 유지됩니다. customInputFields `string` (선택) customInputFieldsToRemove `string` (선택)

엔드포인트

PUT /api/brands/{brandId}/regions/{regionCode}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/brands/{brandId}/regions/{regionCode} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 시설의 브랜드 설정을 조회합니다

매개변수

facilityId `string` (선택) 브랜드 설정을 조회할 시설의 ID

엔드포인트

GET /api/facilities/{facilityId}/brand-settings

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/brand-settings \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

새 브랜드를 생성합니다

매개변수

name `string` (필수) 브랜드 이름 organisationId `string` (필수) 브랜드가 속한 조직의 ID redirectDashboard `string` (선택) 로그인 후 기본 대시보드 대신 리디렉션할 URL

엔드포인트

POST /api/brands

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/brands \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 브랜드 목록을 반환합니다

엔드포인트

GET /api/brands

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

브랜드 객체를 반환합니다

매개변수

brandId `string` (필수) 조회할 브랜드의 ID includeOrganisation `boolean` (선택) 응답에 조직 데이터를 포함할지 여부

엔드포인트

GET /api/brands/{brandId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

ID로 브랜드를 업데이트합니다

매개변수

brandId `string` (선택) 업데이트할 브랜드의 ID name `string` (필수) 브랜드 이름 brandOrganisationId `string` (선택) 브랜드가 속한 조직의 ID redirectDashboard `string` (선택) 로그인 후 기본 대시보드 대신 리디렉션할 URL yextApiKey `string` (선택) 이 브랜드에서 Yext API에 액세스하는 데 사용하는 API 키 customMenuLayout `object` (선택) 브랜드별 사이드 메뉴 레이아웃 트리(시스템 모듈 또는 사용자 지정 URL을 참조하는 섹션/그룹/항목)입니다. 이 브랜드 조직의 조직 관리자만 설정할 수 있습니다.

엔드포인트

PUT /api/brands/{brandId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/brands/{brandId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

브랜드의 시설 나열

브랜드에 속한 시설의 간단한 목록(ID, 이름, 지역 ISO 코드)을 반환합니다. 브랜드 구성에서 시설 대상 선택기를 채우는 데 사용됩니다.

매개변수

brandId `string` (필수) 시설을 나열할 브랜드의 ID

엔드포인트

GET /api/brands/{brandId}/facilities

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/facilities \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 조직과 연결된 모든 브랜드 목록을 반환합니다.

엔드포인트

GET /api/clubs/{club}/brands

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/brands \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 캘린더 유형 목록을 반환합니다

엔드포인트

GET /api/programs/calendars/calendar-types

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/programs/calendars/calendar-types \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

대시보드 배너 삭제

브랜드에 속한 대시보드 배너를 소프트 삭제합니다.

매개변수

brandId `string` (필수) 배너가 속한 브랜드의 ID bannerId `string` (필수) 삭제할 배너의 ID

엔드포인트

DELETE /api/brands/{brandId}/dashboard-banners/{bannerId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/brands/{brandId}/dashboard-banners/{bannerId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

브랜드의 대시보드 배너 나열

관리용으로, 브랜드에 구성된 모든(삭제되지 않은) 대시보드 배너를 반환합니다.

매개변수

brandId `string` (필수) 배너를 나열할 브랜드의 ID

엔드포인트

GET /api/brands/{brandId}/dashboard-banners

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/dashboard-banners \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

대시보드 배너 생성 또는 업데이트

브랜드의 새 대시보드 배너를 생성하거나, 본문에 `bannerId`가 제공되면 기존 배너를 업데이트합니다. 배너는 일정을 지정할 수 있으며(unix 초 단위 시작/종료, null = 제한 없음) 브랜드 전체, 특정 지역(ISO 코드) 또는 특정 시설을 대상으로 지정할 수 있습니다.

매개변수

brandId `string` (필수) 배너가 속한 브랜드의 ID

요청 본문

엔드포인트

PUT /api/brands/{brandId}/dashboard-banners

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/brands/{brandId}/dashboard-banners \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 활성 대시보드 배너 가져오기

시설의 브랜드, 지역(ISO 국가 코드), 각 배너의 활성화 플래그, 일정 기간 및 대상 지정을 기준으로 현재 시설에 표시해야 하는 대시보드 배너를 확인합니다. 대시보드 UI에서 사용합니다.

매개변수

facilityId `string` (필수) 배너를 확인할 시설의 ID

엔드포인트

GET /api/facilities/{facilityId}/dashboard-banners

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/dashboard-banners \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 KYC 에셋을 반환합니다.

매개변수

clubId `string` (필수) 클럽 ID입니다. key `string` (필수) KYC 에셋의 키입니다.

엔드포인트

GET /api/clubs/{clubId}/kyc-assets/{key}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc-assets/{key} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 KYC 정보를 반환합니다.

엔드포인트

GET /api/clubs/{clubId}/kyc

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 KYC 정보를 업데이트합니다.

매개변수

clubId `string` (필수) 업데이트할 클럽의 ID입니다. body `object` (필수)

엔드포인트

PUT /api/clubs/{clubId}/kyc

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 KYC 에셋을 업로드합니다.

매개변수

clubId `string` (필수) 클럽 ID입니다. file `string` (필수) 업로드할 파일입니다.

엔드포인트

POST /api/clubs/{clubId}/kyc-assets

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc-assets \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 기본 설정을 반환합니다.

엔드포인트

GET /api/club/preferences/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/preferences/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽 기본 설정 항목을 생성하거나 업데이트합니다.

요청 본문

엔드포인트

POST /api/club/preferences/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/club/preferences/:club \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

계약이 있는 회원 목록을 반환합니다.

엔드포인트

GET /api/clubpass/user/email/exist/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubpass/user/email/exist/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

계약이 있는 회원 목록을 반환합니다.

엔드포인트

GET /api/clubpass/user/phone/exist/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubpass/user/phone/exist/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 클럽에 속한 사용자 목록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID

엔드포인트

GET /api/clubs/{club}/members

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/members \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 날짜에 클럽이 운영하는지 여부를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. date `string` (필수) 확인할 날짜(unix 형식)

엔드포인트

GET /api/club-busy-hours/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club-busy-hours/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Example Club 웹사이트에 표시되는 클럽의 모든 메타데이터를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/clubpage/clubdata/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/clubpage/clubdata/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

프런트엔드에서 제공한 새 데이터로 클럽의 메타데이터를 업데이트합니다. 요청 본문에 없는 필드는 유지됩니다(SET 및 REMOVE 없음). `null` 또는 빈 문자열로 보낸 필드는 지워집니다. 전용 부분 병합 경로를 사용하려면 `updateAll: false`를 전달하십시오. 어느 경우든 호출자는 자신이 소유하지 않은 필드를 보낼 필요가 없습니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. body `string` (필수) 업데이트할 클럽 데이터의 JSON 객체입니다.

엔드포인트

POST /api/clubs/clubpage/updateclub/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/clubpage/updateclub/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

새 사용자 지정 추적 기록 추가

매개변수

club `string` (필수) 클럽 ID body `string` (필수) 사용자 지정 추적 항목 배열입니다.

엔드포인트

POST /api/clubs/{club}/customtracking

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{club}/customtracking \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 클럽의 사용자 지정 추적을 반환합니다

엔드포인트

GET /api/clubs/customtracking/:clubID

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/customtracking/:clubID \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 지정 추적 항목 업데이트

매개변수

club `string` (필수) 클럽 ID body `string` (필수) 업데이트할 클럽 데이터의 JSON 객체입니다.

엔드포인트

POST /api/clubs/{club}/customtracking/update

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{club}/customtracking/update \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽의 기본 매장 전면 이미지를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club}/default-shop-front

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/default-shop-front \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에서 사용할 수 있는 출입문 나열

매개변수

body `object` (필수) 업데이트할 클럽 데이터의 JSON 객체입니다.

엔드포인트

POST /api/clubs/integrations/doors/:facilityId

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/integrations/doors/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 특정 출입문 잠금 해제

매개변수

body `object` (필수) 업데이트할 클럽 데이터의 JSON 객체입니다.

엔드포인트

POST /api/clubs/integrations/doors/unlock

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/integrations/doors/unlock \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 클럽의 모든 통합과 구성 세부 정보를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/integrations/list/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/integrations/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

프런트엔드에서 제공한 새 데이터로 클럽의 메타데이터를 업데이트합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. body `object` (필수) 업데이트할 클럽 데이터의 JSON 객체입니다.

엔드포인트

POST /api/clubs/integrations/update/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/integrations/update/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

클럽이 유럽 국가에 있는지 여부를 부울 값으로 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. date `string` (필수) 확인할 날짜(unix 형식)

엔드포인트

GET /api/clubs/is-eu/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/is-eu/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

데이터베이스에 있는 모든 클럽의 개략적인 목록을 반환합니다.

엔드포인트

GET /api/clubs/listclubs

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/listclubs \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 날짜에 클럽이 운영하는지 여부를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. date `string` (필수) 확인할 날짜(unix 형식)

엔드포인트

GET /api/clubs/{club}/open-on/{date}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/open-on/{date} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

DynamoDB에서 클럽 리뷰를 가져옵니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

GET /api/clubs/{club}/reviews

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/reviews \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

DynamoDB에서 클럽 리뷰 설정을 가져옵니다.

매개변수

facilityId `string` (필수) 시설 ID

엔드포인트

GET /api/clubs/{club}/reviews-settings

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

DynamoDB의 클럽 리뷰 설정을 업데이트합니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

PUT /api/clubs/{club}/reviews-settings

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰 설정의 자동 게시를 다시 사용 설정합니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

PUT /api/clubs/{club}/reviews/publish-recent-reviews

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/publish-recent-reviews \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰를 게시합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. review `string` (필수) 게시할 리뷰의 내부 ID입니다.

엔드포인트

PUT /api/clubs/{club}/reviews/{review}/publish

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/{review}/publish \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰 설정의 자동 게시를 다시 사용 설정합니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

PUT /api/clubs/{club}/reviews-settings/re-enable-auto-publish

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings/re-enable-auto-publish \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰가 처음 게시된 게시처(Google 등)를 통해 리뷰에 대한 답글을 게시합니다.

매개변수

club `string` (필수) 시설 ID reviewId `string` (필수) PH 리뷰 ID(club-social-reviews 테이블에서 조회) body `string` (필수)

엔드포인트

POST /api/clubs/{club}/reviews/{reviewId}/respond

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/{reviewId}/respond \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰 게시를 취소합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. review `string` (필수) 게시를 취소할 리뷰의 내부 ID입니다.

엔드포인트

PUT /api/clubs/{club}/reviews/{review}/un-publish

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/{review}/un-publish \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

PH DB에서 지정한 클럽에 속한 소유자 목록을 반환합니다

매개변수

clubID `string` (필수) 액세스할 클럽의 내부 ID

엔드포인트

GET /api/clubs/{clubID}/owners

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/owners \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 모든 회원권 플랜을 반환합니다.

매개변수

facilityId `string` (필수) 시설의 내부 ID

엔드포인트

GET /api/facilities/membership-plans/:facilityId

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/membership-plans/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

회원권 플랜 기록을 업데이트합니다.

매개변수

facilityId `string` (필수) 시설의 내부 ID body `object` (필수) 업데이트할 회원권 플랜 데이터의 JSON 객체입니다.

엔드포인트

PUT /api/facilities/membership-plans/:facilityId

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/facilities/membership-plans/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰 설정의 자동 게시를 다시 사용 설정합니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

PUT /api/clubs/{club}/reviews/publish-recent-reviews

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/publish-recent-reviews \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

리뷰 설정의 자동 게시를 다시 사용 설정합니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

PUT /api/clubs/{club}/reviews-settings/re-enable-auto-publish

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings/re-enable-auto-publish \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용 가능한 모든 통화 목록을 반환합니다

엔드포인트

GET /api/currencies

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/currencies \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

IP 주소를 사용하여 지리적 위치를 반환합니다.

매개변수

ip `string` (필수) 조회할 IP 주소

엔드포인트

GET /api/geo/ip-location/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/geo/ip-location/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

현재 사용자의 IP를 기준으로 지리적 위치를 반환합니다.

엔드포인트

GET /api/geo/ip-current

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/geo/ip-current \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

요청한 클라이언트의 공용 IP 주소만 반환합니다(지리적 위치 조회 및 타사 API 호출 없음). AI 에이전트 애플릿에서 브라우저의 공용 IP와 기기가 보고한 WAN IP를 비교하여 동일 네트워크 여부를 감지하는 데 사용합니다.

엔드포인트

GET /api/geo/client-ip

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/geo/client-ip \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

전화번호 파서입니다.

매개변수

body `string` (필수) 파싱할 전화번호의 JSON 객체입니다.

엔드포인트

POST /api/phone/parser

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/phone/parser \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

마스터 시계 기기를 반환합니다

매개변수

club_id `string` (필수) 기기를 추가할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club_id}/smart-club/health-check/master-clock

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/master-clock \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

마스터 Sonos 기기를 반환합니다

매개변수

club_id `string` (필수) 기기를 추가할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club_id}/smart-club/health-check/sonos-mqtt

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/sonos-mqtt \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 클럽의 비상 경보 기기 배터리 부족 알림을 가져옵니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club}/smart-club/health-check/low-battery-duress

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/smart-club/health-check/low-battery-duress \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

네트워크 분석 데이터를 반환합니다

매개변수

club_id `string` (필수) 기기를 추가할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club_id}/smart-club/health-check/network-analysis

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/network-analysis \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 클럽의 비상 경보 기기 배터리 부족 알림을 보냅니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club}/smart-club/health-check/send-low-battery-duress-notifs

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/smart-club/health-check/send-low-battery-duress-notifs \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기기 유형별 기기 속도 테스트 데이터를 반환합니다

매개변수

club_id `string` (필수) 기기를 추가할 클럽의 내부 ID입니다.

엔드포인트

GET /api/clubs/{club_id}/smart-club/health-check/speed-test

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/speed-test \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 리스팅 인사이트를 가져옵니다. 기본적으로 게시처 전체의 일별 합계를 집계하여 반환하며, `publisherId`를 지정하면 단일 게시처의 데이터를 반환합니다.

매개변수

facilityId `string` (필수) publisherId `string` (선택) startDate `string` (필수) endDate `string` (필수)

엔드포인트

GET /api/facilities/{facilityId}/directory-insights

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/directory-insights \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 게시처에 걸쳐 브랜드의 집계된 리스팅 인사이트를 가져옵니다.

매개변수

brandId `string` (필수) startDate `string` (필수) endDate `string` (필수)

엔드포인트

GET /api/brands/{brandId}/directory-insights

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/directory-insights \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 상위 검색 키워드(브랜드/비브랜드 구분 포함)이며, 현재 Google Business Profile에서 가져옵니다.

매개변수

facilityId `string` (필수) publisherId `string` (선택) 기본값은 "google"입니다. 현재는 Google만 지원됩니다. startDate `string` (필수) endDate `string` (필수) limit `string` (선택)

엔드포인트

GET /api/facilities/{facilityId}/directory-search-keywords

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/directory-search-keywords \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 시설에 걸쳐 집계된 브랜드의 상위 검색 키워드입니다.

매개변수

brandId `string` (필수) startDate `string` (필수) endDate `string` (필수) limit `string` (선택)

엔드포인트

GET /api/brands/{brandId}/directory-search-keywords

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/directory-search-keywords \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Q&A를 나열합니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/facilities/{facilityId}/qna

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/qna \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

질문에 답변합니다.

엔드포인트

POST /api/facilities/{facilityId}/qna/{questionId}/answer

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/facilities/{facilityId}/qna/{questionId}/answer \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

답변을 삭제합니다.

엔드포인트

DELETE /api/facilities/{facilityId}/qna/{questionId}/answer/{answerId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/facilities/{facilityId}/qna/{questionId}/answer/{answerId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 조직에 활성화된 게시처를 연결 상태와 함께 반환합니다.

매개변수

facilityId `string` (필수) organisationId `string` (필수)

엔드포인트

GET /api/facilities/{facilityId}/directory-publishers/resolved

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/directory-publishers/resolved \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 공유 Door/Gate Access 설정 가져오기

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/rules/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/rules/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 공유 Door/Gate Access 설정 업데이트

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/rules/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/rules/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 Access Policies 가져오기

기존 접근 구성은 처음 읽을 때 동일한 효력의 적용 정책으로 자동 변환됩니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/policies/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

낙관적 리비전 검사를 사용하여 Access Policies 교체

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/policies/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Access Policy 만들기

매개변수

facilityId `string` (필수)

엔드포인트

POST /api/door-access/policies/{facilityId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Access Policy 하나 업데이트

매개변수

facilityId `string` (필수) policyId `string` (필수)

엔드포인트

PATCH /api/door-access/policies/{facilityId}/{policyId}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Access Policy 하나 삭제

매개변수

facilityId `string` (필수) policyId `string` (필수) revision `integer` (필수)

엔드포인트

DELETE /api/door-access/policies/{facilityId}/{policyId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

새 고정 ID로 Access Policy 복제

매개변수

facilityId `string` (필수) policyId `string` (필수)

엔드포인트

POST /api/door-access/policies/{facilityId}/{policyId}/duplicate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId}/duplicate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 Access Policies의 영향을 받는 사용자 및 문 수 집계

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/policies/{facilityId}/impacts

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/impacts \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Access Policy의 영향을 받는 사용자 및 문 수 집계

매개변수

facilityId `string` (필수) policyId `string` (필수)

엔드포인트

GET /api/door-access/policies/{facilityId}/{policyId}/impact

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId}/impact \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 인원 유형, 상태 및 태그 목록

시설의 User Access 행(ph-door-access-users)에 있는 고유한 인원 유형, 멤버십 상태 및 태그 값을 반환합니다. 이 값은 파트너 동기화와 수동 입력에서 파생됩니다. door-gate-access 애플릿은 이 값으로 접근 규칙 드롭다운을 채웁니다. 태그는 규칙 평가기와 마찬가지로 동기화된 `tags`와 관리자 `customTags`의 합집합입니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/people-config/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/people-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 도어 컨트롤러와 적용 중인 Door/Gate Access 규칙 목록

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/doors/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

문별 재정의, 아이콘 및 기기 측 구성 저장

DGA 관리 애플릿이 문에서 편집하는 모든 항목에 대한 단일 쓰기 엔드포인트입니다. - `accessRulesOverride` / `geofenceOverride` — `null`을 전달하면 값을 지우고 시설 기본값으로 돌아갑니다. - `icon` — 고정 전송 키입니다(services/door-access/door-icons.js 참조). 알 수 없는 값은 400을 반환합니다. - `holdTimeSeconds`(1–30), `maintenanceMode`(`off` / `force-open` / `force-closed`), `doorLocation`(자유 텍스트, 64자 이하), `playNotificationSoundOnRelayToggle`(boolean), `autoUnlockSchedule`(주간 시간대 그리드). 이전에는 Device Management 전용 필드였지만 이제 애플릿에서 직접 기록하므로, 관리자는 일상적인 구성 변경을 위해 문 드로어를 벗어날 필요가 없습니다. 기기 측 필드가 변경되면 이 경로는 해당 Balena 환경 변수(`RELAY_NOTIFICATION_SOUND`, `DOOR_MAINTENANCE_MODE`, `DOOR_AUTO_UNLOCK_SCHEDULE`)도 전달하고 `unlockUpdates` MQTT 명령을 보내므로, 기기는 다음 Balena 환경 갱신을 기다리지 않고 새 구성을 적용합니다. 최선 노력 방식이므로 Balena에 일시적으로 연결할 수 없어도 응답은 200입니다.

매개변수

facilityId `string` (필수) doorId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/doors/{facilityId}/{doorId}/override

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/override \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

문 드로어의 다시 로드 안내를 위한 경량 Balena 상태 확인

DGA 애플릿의 드로어는 관리자가 문을 열 때 이 정보를 지연 로드하여 적절한 "저장하면 컨트롤러가 다시 로드됩니다" 문구를 표시합니다. 기본 문구는 "몇 초"이며, 릴리스 업데이트도 대기 중이면 더 강한 "몇 분" 문구가 표시됩니다. `balena.models.device.get()`에서 파생된 단순 스냅샷을 반환합니다. 오류 시 5xx 대신 `data: null`로 처리하므로, Balena 장애가 발생해도 드로어가 열리지 않는 대신 안내 문구만 단순해집니다.

매개변수

facilityId `string` (필수) doorId `string` (필수)

엔드포인트

GET /api/door-access/doors/{facilityId}/{doorId}/device-status

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/device-status \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

관리자 재정의 — 애플릿에서 문 잠금 해제

문의 현재 `holdTimeSeconds`를 사용하여 릴레이를 잠시 전환하고, ph-door-app-access-events에 `admin-override` 감사 행을 기록하여 접근 로그에서 해당 작업의 수행자를 확인할 수 있도록 합니다. `maintenanceMode === 'force-closed'`인 경우에도 항상 성공하며, 이는 관리자용 비상 수단입니다. MQTT 게시가 전송되는 즉시 200을 반환하며, 확인됨/실패/시간 초과 상태는 여기서 기다리지 않습니다(기존 /api/devices/door-controllers + /api/ics/devices/command 흐름도 전송 후 응답을 기다리지 않습니다).

매개변수

facilityId `string` (필수) doorId `string` (필수)

엔드포인트

POST /api/door-access/doors/{facilityId}/{doorId}/unlock

요청 예시

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

응답

{}

도어 컨트롤러에서 위치 확인용 비프음 재생

`beep` MQTT 명령을 게시하여 컨트롤러가 중간 길이의 비프음을 세 번 울리도록 합니다(각 약 500 ms, 간격 약 350 ms, 총 약 2 s). 관리자가 현장에서 도어 컨트롤러의 위치를 물리적으로 찾을 때 사용합니다. 기존 Device Management 버튼은 약 30 s 동안 짧은 비프음을 연속으로 울리지만 펌웨어 부저 드라이버가 첫 번째 비프음만 안정적으로 울리므로, 애플릿은 더 짧고 안정적인 패턴을 보냅니다. 접근 제어에 영향이 없는 진단 작업이므로 감사 행은 기록하지 않습니다.

매개변수

facilityId `string` (필수) doorId `string` (필수)

엔드포인트

POST /api/door-access/doors/{facilityId}/{doorId}/identify

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/identify \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

도어 컨트롤러 원격 재부팅

기존 Device Management의 "Remotely Reboot Device" 버튼이 보내는 것과 동일한 전송 후 응답을 기다리지 않는 `rebootDevice` MQTT 명령을 게시하지만, `door-gate-access` 모듈로 제한되므로 DGA 관리자는 별도의 `device-management` 권한 없이 문 드로어의 고급 섹션에서 컨트롤러를 재부팅할 수 있습니다. 게시가 전송되는 즉시 200을 반환하며, 재부팅하는 동안 기기는 오프라인 상태가 됩니다.

매개변수

facilityId `string` (필수) doorId `string` (필수)

엔드포인트

POST /api/door-access/doors/{facilityId}/{doorId}/reboot

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/reboot \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 User Access 행 목록

시설에서 삭제되지 않은 모든 사용자 접근 행을 반환합니다. 클라이언트 측 필터(source, search, accessEnabled, hasGrants)를 지원합니다. 4단계의 `hideExcluded` 서버 측 계산은 하이브리드 권한 부여 평가기가 도입되면 추가될 예정이며, 현재는 매개변수를 받지만 전체 집합을 반환합니다.

매개변수

facilityId `string` (필수) search `string` (선택) source `string` (선택) accessEnabled `string` (선택) hasGrants `string` (선택) hideExcluded `boolean` (선택) true이면 이 시설에서 어떤 시간에도 어떤 문도 통과할 수 없는 동기화된 사용자(source != manual)가 숨겨집니다. 응답에는 `hidden: { count, sample }` 엔벨로프가 포함됩니다.

엔드포인트

GET /api/door-access/users/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/users/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에서 User Access 행 수동 생성

`source: 'manual'`로 새 행을 생성합니다. 제공된 전화번호 또는 이메일이 이미 이 시설의 행에 매핑되어 있으면 `existingUserId`와 함께 409를 반환합니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/users/{facilityId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

단일 User Access 행 가져오기

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

GET /api/door-access/users/{facilityId}/{userId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

User Access 행 부분 업데이트

신원/권한 부여 필드의 일부를 편집합니다. 선택 필드를 지우려면 `null`을 전달하십시오. 새 전화번호 또는 이메일이 같은 시설의 다른 행과 충돌하면 409를 반환합니다. `appMessage`는 PUT /api/door-access/rules/{facilityId}의 시설 전체 메시지와 같은 형식(본문 텍스트, 심각도, 선택적 링크, 선택적 시작/종료 일정)을 받습니다. 모바일 앱은 대상 사용자에게만 대시보드에 이 메시지를 표시합니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

요청 본문

엔드포인트

PATCH /api/door-access/users/{facilityId}/{userId}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

User Access 행 소프트 삭제

행을 `deleted: true`로 표시하고 접근을 비활성화합니다. userId에 대한 감사 로그 연결은 유지되며, 관리자가 수동으로 다시 활성화할 수 있습니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

DELETE /api/door-access/users/{facilityId}/{userId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자의 문별 접근 근거

모든 문에 대해 현재의 결정적 권한 부여 결과(`allowedNow`, `allowedVia`, `deniedReason`)와 Access Policies, 영구 권한 부여, 정책 일정, 관리자 시간대 권한 부여, 최신 매핑된 파트너 소스 시간대에 대해 구성된 경로를 반환합니다. 또한 현재/다음 이용 가능 시간과 소스 최신성도 반환합니다. 문의 blockAllAccess 및 유지 관리 상태는 모든 허용 경로보다 먼저 평가됩니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

GET /api/door-access/users/{facilityId}/{userId}/effective-access

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/effective-access \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CSV 가져오기로 User Access 행 일괄 생성

한 번의 요청으로 여러 `source: 'manual'` 행을 생성하며, 단일 생성과 동일한 유효성 검사, 전화번호/이메일 정규화, 시설별 충돌 검사, 자동 메시지 및 (선택적) 초대 로직을 사용합니다. 행은 순서대로 처리되므로 나중 행이 앞서 생성된 행과 충돌하면 중복으로 보고됩니다. 권한 부여는 이미 확정된 문/그룹 ID로 제공됩니다(클라이언트가 이름을 ID로 변환합니다). 시간대 권한 부여는 일괄 처리에서 의도적으로 거부되며, 가져오기 후 사용자별 교체 엔드포인트를 통해 추가해야 합니다. 행 단위로 예외를 발생시키지 않으며, 각 행의 결과가 개별적으로 보고됩니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/users/{facilityId}/bulk

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/bulk \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

User Access 행의 하이브리드 권한 부여 교체

3단계 하이브리드 평가기 연결입니다. 권한 부여는 시설 태그 규칙과 함께 적용되며, 잠금 해제 시점에 둘 중 하나라도 일치하면 사용자가 허용됩니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/users/{facilityId}/{userId}/grants

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/grants \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

User Access 행의 추가 Access Time Window 권한 부여 교체

`timeWindowGrants`만 교체하며, 영구 `grants`와 통합 `sourceTimeWindows`는 변경되지 않습니다. 각 항목에는 범위(`facilityWide`, `doors` 또는 `groups`)와 절대 또는 주간 `window`가 필요합니다. 빈 배열을 보내면 모든 관리자 시간대가 명시적으로 지워집니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/users/{facilityId}/{userId}/time-window-grants

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/time-window-grants \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

소스 기반 동기화 업데이트에서 User Access 행 고정

`decoupledFromSource: true`를 설정하고, 통합에서 관리하는 모든 `sourceTimeWindows`를 지우며, 관리자가 /recouple을 통해 플래그를 해제할 때까지 동기화(cron + 스트림)가 이 행을 로그에 기록하고 건너뛰도록 합니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

POST /api/door-access/users/{facilityId}/{userId}/decouple

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/decouple \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

User Access 행을 소스 기반 동기화 업데이트에 다시 연결

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

POST /api/door-access/users/{facilityId}/{userId}/recouple

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/recouple \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자의 모든 Door/Gate Access 앱 새로 고침 토큰 취소

사용자의 저장된 전화번호/이메일로 취소합니다(새로 고침 토큰 테이블은 `sha256(plaintext)`를 키로 사용하며, byMobilePhone / byEmail GSI를 통해 단일 사용자 기준으로 일괄 삭제할 수 있습니다). 다른 시설에서 같은 전화번호/이메일을 공유하는 다른 사용자도 로그아웃됩니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

POST /api/door-access/users/{facilityId}/{userId}/logout

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/logout \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자에게 Door/Gate Access 앱 초대 이메일 (재)전송

사용자의 저장된 이메일 주소로 앱 다운로드 초대 이메일을 강제로 보냅니다(이메일만 해당하며 SMS는 보내지 않음). 자동 동기화 경로에서 사용하는 자격 및 이미 전송됨 검사는 무시되며, 이는 명시적인 관리자 작업입니다. 사용자의 이메일이 등록되어 있지 않으면 400을 반환합니다.

매개변수

facilityId `string` (필수) userId `string` (필수)

엔드포인트

POST /api/door-access/users/{facilityId}/{userId}/resend-invite

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/resend-invite \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

앱 초대 일괄 전송의 수신자 미리 보기

앱 초대 이메일을 받게 될 사용자 집합을 계산합니다. 기본 대상은 앱을 사용한 적이 없는(`appLastSeenAt`이 비어 있는) 이메일 보유 사용자 중 삭제되지 않은 모든 사용자입니다. 기본적으로 현재 접근 권한이 있고(규칙 일치 또는 권한 부여) 초대받은 적이 없는 사용자로 범위가 좁혀지며, `includeAlreadyInvited` 및 `includeNoAccess`로 범위를 넓힐 수 있습니다. 이메일은 전송되지 않으며, 건수, 소규모 샘플, 실행 엔드포인트에 사용할 후보 userId를 반환합니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/users/{facilityId}/bulk-invite/preview

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/bulk-invite/preview \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

사용자 일괄 대상에게 앱 초대 이메일 전송

제공된 각 userId에 앱 다운로드 초대 이메일을 보냅니다(요청당 최대 50개이며, 클라이언트가 미리 보기의 전체 후보 목록을 나누어 보냅니다). 각 사용자는 전송 시점에 다시 검증되며, 더 이상 존재하지 않거나 이메일이 없거나 미리 보기 이후 앱을 사용한 행은 실패가 아닌 건너뜀으로 처리됩니다. 사용자별 결과가 개별적으로 보고되므로 클라이언트는 전송됨/실패/건너뜀을 요약할 수 있습니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/users/{facilityId}/bulk-invite

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/bulk-invite \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 Door Group 목록

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/door-groups/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Door Group 만들기

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/door-groups/{facilityId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

단일 Door Group 가져오기

매개변수

facilityId `string` (필수) groupId `string` (필수)

엔드포인트

GET /api/door-access/door-groups/{facilityId}/{groupId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId}/{groupId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Door Group 업데이트

매개변수

facilityId `string` (필수) groupId `string` (필수)

요청 본문

엔드포인트

PATCH /api/door-access/door-groups/{facilityId}/{groupId}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId}/{groupId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Door Group 소프트 삭제

매개변수

facilityId `string` (필수) groupId `string` (필수)

엔드포인트

DELETE /api/door-access/door-groups/{facilityId}/{groupId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId}/{groupId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에 구성된 파트너 통합 목록

ph-facility-partner-config를 ph-partners 카탈로그와 결합하여 시설의 파트너 통합(id, 이름, 로고, 활성화 여부)을 반환합니다. door-gate-access 범위이므로 외부 통합 접근 권한이 없는 관리자도 파트너 배지와 파트너별 동기화 목록을 표시할 수 있습니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/partners/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/partners/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 User Access 동기화 구성 읽기

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/sync-config/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/sync-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 User Access 동기화 구성 업데이트

관리자가 제어하는 필드(`enabled`, `requireIdentifier` 및 파트너 `partners` 맵)만 허용됩니다. `lastRunAt` 및 `lastRunCounts`는 동기화 엔진이 직접 기록합니다. `partner.partners`는 partnerId를 키로 하는 파트너별 활성화 맵(옵트아웃 방식)입니다. 마스터 `partner.enabled`가 켜져 있으면 여기에 명시적인 `{ enabled: false }` 항목이 없는 한 파트너가 동기화됩니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/sync-config/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/sync-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 사용자별 자동 메시지 구성 읽기

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/auto-messages/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/auto-messages/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 사용자별 자동 메시지 구성 업데이트

규칙을 저장한 다음 시설의 모든 User Access 행을 즉시 다시 평가하므로, 기존 사용자에게 자동 메시지가 바로 적용되거나 해제됩니다. 수동 메시지와 분리된 행은 변경되지 않습니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/auto-messages/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/auto-messages/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

백그라운드 자동 메시지 재평가 작업 상태

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/auto-messages/{facilityId}/sweep-status

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/auto-messages/{facilityId}/sweep-status \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 User Access 동기화 즉시 실행

시설에서 활성화된 모든 소스(partner / cctv)를 동기적으로 처리하고 중복 제거 워터폴을 통해 ph-door-access-users 행을 일치시킵니다. 소스별 건수를 반환합니다. 비활성화된 소스는 누락되지 않고 `skippedSyncDisabled: 1`로 표시되므로 UI에서 두 행을 일관되게 표시할 수 있습니다.

매개변수

facilityId `string` (필수)

엔드포인트

POST /api/door-access/sync/{facilityId}/run

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/run \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

파트너 동기화 일괄 삭제의 시험 실행 미리 보기

소프트 삭제될 사용자 접근 행의 수와 샘플, 그리고 실행 엔드포인트로 그대로 다시 보내야 하는 confirmToken을 반환합니다. 데이터는 수정되지 않습니다. 접근 로그는 영향을 받지 않습니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/sync/{facilityId}/bulk-delete/preview

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/bulk-delete/preview \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

파트너 동기화 일괄 삭제 실행(소프트 삭제)

범위 내 파트너 동기화 사용자 접근 행을 모두 소프트 삭제합니다. 미리 보기에서 반환된 confirmToken이 필요합니다. 미리 보기 이후 실제 집합이 변경되었으면 토큰이 일치하지 않아 요청이 거부되므로(409) 관리자가 다시 검토해야 합니다. 접근 로그는 보존됩니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/door-access/sync/{facilityId}/bulk-delete

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/bulk-delete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

최근 User Access 동기화 활동(문제 해결 로그)

시설의 최근 동기화 결과(생성됨/건너뜀/비활성화됨)를 이유와 함께 반환하므로, 관리자는 회원이 동기화되거나 되지 않은 이유를 확인할 수 있습니다. 최신순입니다.

매개변수

facilityId `string` (필수) limit `integer` (선택)

엔드포인트

GET /api/door-access/sync/{facilityId}/log

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/log \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Door/Gate Access 이벤트 목록

모바일, 관리자 재정의 및 외부 Partner API 잠금 해제 이벤트를 하나의 피드로 최신순으로 반환합니다.

매개변수

facilityId `string` (필수) from `integer` (선택) to `integer` (선택) limit `integer` (선택)

엔드포인트

GET /api/door-access/events/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/events/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

관리자 테스트 모드 핀에 대한 Geofence 평가 시험 실행

요청 본문

엔드포인트

POST /api/door-access/geofence/test

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/door-access/geofence/test \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 온보딩/활성화 상태 가져오기

애플릿의 "시작하기" 랜딩 화면과 설정 진행 배너에 사용됩니다. 실시간 문 + 사용자 수, 파생된 두 가지 핵심 단계(사용자 존재, 문 존재), 저장된 선택적 "검토됨" 플래그, 시설이 활성화되었는지 여부(두 핵심 단계 모두 완료)를 반환합니다. 시설이 처음 활성화되면 activatedAt 타임스탬프가 기록됩니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/door-access/onboarding/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/door-access/onboarding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 선택적 온보딩 "검토됨" 플래그 업데이트

관리자가 체크하는 선택적 설정 체크리스트 플래그(접근 규칙, 동기화 설정, Geofence)를 저장합니다. 핵심 단계와 활성화 여부는 데이터 건수에서 실시간으로 파생되며 여기서 설정할 수 없습니다. 갱신된 전체 온보딩 상태를 반환합니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/door-access/onboarding/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/onboarding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

clubId `string` (선택) 분석 데이터를 가져올 시설의 시설 ID입니다. fromDate `string` (선택) 가져올 분석 데이터의 시작 날짜입니다. toDate `string` (선택) 가져올 분석 데이터의 종료 날짜입니다.

엔드포인트

GET /clubs/{clubId}/lead-events

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/lead-events \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

엔드포인트

GET /clubs/{clubId}/analytics/page-views

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/page-views \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

엔드포인트

GET /clubs/{clubId}/analytics/referrers

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/referrers \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

엔드포인트

GET /clubs/{clubId}/analytics/socials

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/socials \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

엔드포인트

GET /clubs/{clubId}/analytics/top-cities

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/top-cities \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

엔드포인트

GET /clubs/{clubId}/analytics/total-page-views

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/total-page-views \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 분석 데이터를 JSON 응답으로 반환합니다.

매개변수

엔드포인트

GET /clubs/{clubId}/analytics/traffic

요청 예시

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/traffic \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

프런트엔드 'analytics' 페이지의 Google Analytics 임베드 차트용 임시 프런트엔드 JWT(JSON Web Token)를 생성합니다.

엔드포인트

GET /api/ga/onetimetoken

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ga/onetimetoken \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에 활성 회원이 있는 경우 'The Training Camp'의 대시보드 위젯을 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/reporting/apps/widgets/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/apps/widgets/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

검토되지 않은 모든 시설 휴일을 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/reporting/club/{club}/unreviewed-holidays

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/club/{club}/unreviewed-holidays \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

검토되지 않은 모든 시설 휴일을 검토됨으로 설정합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

PUT /api/reporting/club/{club}/review-holidays

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/reporting/club/{club}/review-holidays \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지난 12개월 동안의 KPI 보고서를 월별로 나누어 CSV 형식으로 반환합니다. *참고* 이 작업은 시스템의 모든 시설에 대한 단일 보고서를 생성합니다. 여러 번 병렬로 실행하면 GymMaster에 과부하가 걸리므로 그렇게 하지 마십시오!

매개변수

months `string` (선택) 가져올 개월 수(현재 날짜 기준, 기본값 12)

엔드포인트

GET /api/reporting/gymmaster/all-clubs-kpi-report

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/all-clubs-kpi-report \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 시설의 MMS 수익 그래프를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. range `string` (선택) 가져올 기간(현재 날짜부터 역산한 일수)

엔드포인트

GET /api/reporting/gymmaster/revenuegraph/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/revenuegraph/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 시설의 대시보드 MMS(Member Management System) 데이터/분석을 반환합니다. 데이터에는 GymMaster/Perfect Gym 통계와 시스템에서 수집한 기타 내부 지표가 포함됩니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. range `string` (선택) 가져올 기간(현재 날짜부터 역산한 일수)

엔드포인트

GET /api/reporting/gymmaster/widgets/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/widgets/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 시설의 대시보드 Myzone 위젯 데이터를 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/reporting/myzone/widgets/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/myzone/widgets/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

내부 'Uptime Kuma' 도구로 구성된 하나 이상의 상태 페이지/모니터링 엔드포인트에서 오프라인으로 판단된 서비스 객체를 반환합니다.

엔드포인트

GET /api/reporting/statuspage/events

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/statuspage/events \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

향후 7일 동안 예정된 운동 예약을 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/reporting/clubs/{club}/workout-bookings

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/reporting/clubs/{club}/workout-bookings \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 과거 휴일 목록을 반환합니다.

매개변수

clubId `string` (선택) 클럽 ID fromDate `string` (선택) 반환할 휴일 범위의 시작 날짜(Unix 타임스탬프)입니다. toDate `string` (선택) 반환할 휴일 범위의 종료 날짜(Unix 타임스탬프)입니다.

엔드포인트

GET /api/clubs/{clubId}/historical-holidays

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/historical-holidays \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설과 연결된 기기 자동화를 반환합니다.

매개변수

club `string` (필수) 기기를 나열할 클럽의 내부 ID입니다.

엔드포인트

GET /api/ics/automations/list/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ics/automations/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 디스플레이/기기의 기기 구성을 업데이트합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/ics/automations/update/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ics/automations/update/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

물리적 화면 기기/컴퓨터를 시설에 추가하거나 연결합니다.

매개변수

club `string` (필수) 기기를 추가할 클럽의 내부 ID입니다. body `string` (필수) 연결할 새 스크린의 JSON 객체입니다.

엔드포인트

POST /api/ics/devices/add/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/add/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

매개변수에 따라 새 SSID에 연결하도록 기기에 지시합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/ics/devices/changewifi/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/changewifi/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 디스플레이/기기의 기기 구성을 업데이트합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/ics/devices/command/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/command/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 기기 화면에 URL/웹 페이지를 로드합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

POST /api/ics/devices/loadurl/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/loadurl/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 디스플레이/기기의 기기 구성을 업데이트합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

PUT /api/ics/devices/update/{club}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/ics/devices/update/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

디스플레이/기기의 이름을 변경합니다. 등록 정보만 변경하며, 업데이트 엔드포인트와 달리 기기에 아무것도 전달하지 않으므로 지원이 종료된 소프트웨어 빌드를 실행하는 화면에서도 사용할 수 있습니다.

매개변수

club `string` (필수) 기기가 속한 시설의 내부 ID입니다. body `string` (필수) 이름 변경 매개변수의 JSON 객체입니다.

엔드포인트

PUT /api/ics/devices/rename/{club}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/ics/devices/rename/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

제공된 날짜를 기준으로 시설의 위젯과 오프라인 미디어 링크를 가져옵니다.

매개변수

club `string` (필수) 프로그램을 변경할 시설의 내부 ID입니다. date `string` (필수) 위젯 URL을 반환할 날짜입니다. `YYYY-MM-DD` 형식을 사용하십시오.

엔드포인트

GET /api/ics/external-resources/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ics/external-resources/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

제공된 날짜를 기준으로 시설의 위젯과 오프라인 미디어 링크를 가져옵니다.

매개변수

club `string` (필수) 프로그램을 변경할 시설의 내부 ID입니다.

엔드포인트

GET /api/ics/list-scheduled-workouts/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ics/list-scheduled-workouts/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 시설의 프로그램을 변경합니다.

매개변수

club `string` (필수) 프로그램을 변경할 시설의 내부 ID입니다. body `string` (필수) 변경할 새 프로그램의 JSON 객체입니다.

엔드포인트

POST /api/ics/loadprogram/{club}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ics/loadprogram/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 디스플레이/기기의 프로그램 구성을 가져옵니다.

매개변수

club `string` (필수) 프로그램 데이터를 가져올 시설의 내부 ID입니다.

엔드포인트

GET /api/ics/programs/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ics/programs/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 디스플레이/기기의 프로그램 구성을 업데이트합니다.

매개변수

club `string` (필수) 기기를 업데이트할 시설의 내부 ID입니다. body `string` (필수) 업데이트 매개변수의 JSON 객체입니다.

엔드포인트

PUT /api/ics/programs/{club}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/ics/programs/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

프로그램 구성 옵션을 가져옵니다.

엔드포인트

GET /api/ics/programs/options/{facilityID}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ics/programs/options/{facilityID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

RAG 컨텍스트를 사용한 채팅입니다. 도구에는 접근할 수 없으며, 지식 베이스에서 지식을 직접 가져올 수 있는 단순한 API 요청/응답 도구만 사용할 수 있습니다.

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

요청 본문

엔드포인트

POST /api/llm/chat

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/chat \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

벡터 저장소에서 문서 임베딩을 삭제하고 임베딩 추적 상태 업데이트

요청 본문

엔드포인트

DELETE /api/llm/delete-article

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/llm/delete-article \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

조직 및 상태별 임베딩 추적 레코드 목록

매개변수

organisationId `string` (선택) 조직 ID(생략하면 자동으로 확인됨) status `string` (필수) 필터링할 상태(in_queue, done, anomaly, fail, deleted 중 하나여야 함) Limit `string` (선택) 페이지당 최대 항목 수 LastEvaluatedKey `string` (선택) 페이지 매김용 DynamoDB LastEvaluatedKey의 JSON

엔드포인트

GET /api/llm/embedding-track/by-org-and-status

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/llm/embedding-track/by-org-and-status \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직별 임베딩 추적 레코드 목록(선택적으로 리소스 유형별 필터링)

매개변수

organisationId `string` (선택) 조직 ID(생략하면 자동으로 확인됨) resourceType `string` (선택) 선택적 리소스 유형(예: "article")입니다. 제공하면 resourceTypeId가 "{type}#"로 시작하는 항목으로 필터링합니다. Limit `string` (선택) 페이지당 최대 항목 수 LastEvaluatedKey `string` (선택) 페이지 매김용 DynamoDB LastEvaluatedKey의 JSON

엔드포인트

GET /api/llm/embedding-track/by-org

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/llm/embedding-track/by-org \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직 벡터 데이터베이스 컬렉션 초기화

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

엔드포인트

POST /api/llm/init-org

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/init-org \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지식 베이스에서 의미 기반 검색

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

요청 본문

엔드포인트

POST /api/llm/semantic-search

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/semantic-search \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

실시간 진행 상황 업데이트와 함께 대기 중인 문서의 임베딩 스트리밍 처리 시작

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

엔드포인트

POST /api/llm/start-embedding-stream

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/start-embedding-stream \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

벡터 데이터베이스에 문서 임베딩 업서트

현재 상태에 따라 문서 임베딩을 처리합니다. - 문서가 게시되지 않았거나 비공개인 경우: 임베딩을 삭제합니다 - 문서가 게시되었고 공개인 경우: 전체 콘텐츠로 다시 임베딩합니다 항상 전체 문서 본문이 필요합니다.

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

요청 본문

엔드포인트

POST /api/llm/upsert-embeddings

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/upsert-embeddings \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

조직 및 선택적 상태별로 문서 임베딩을 일괄 삭제하는 테스트 엔드포인트

매개변수

organisationId `string` (선택) 조직 ID(생략하면 사용자 컨텍스트에서 자동으로 확인됨) status `string` (선택) 필터링할 상태(선택 사항이며, 생략하면 상태와 관계없이 조직의 모든 문서를 삭제함) hardDelete `string` (선택) 임베딩 추적 레코드를 완전히 삭제할지(true) 또는 상태를 업데이트하여 소프트 삭제할지(false) 여부

엔드포인트

DELETE /api/llm/test/batch-delete-by-status

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/llm/test/batch-delete-by-status \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

상세 통계와 함께 텍스트 변환 및 청크 분할

텍스트를 변환하고 청크로 분할한 다음, 문자 수, 비율, 품질 지표를 포함한 청크 분포에 대한 상세 통계를 제공하여 청크 분할의 효과를 평가할 수 있도록 하는 테스트 엔드포인트입니다.

요청 본문

엔드포인트

POST /api/llm/test/transform-chunk

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/test/transform-chunk \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

조직의 벡터 인덱스에 있는 벡터 총수 가져오기

현재 사용자 조직의 벡터 인덱스에 있는 모든 벡터 수를 세는 테스트 엔드포인트

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

엔드포인트

GET /api/llm/test/vector-count

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/llm/test/vector-count \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

벡터 인덱스에서 특정 articleId의 모든 벡터 삭제

현재 사용자 조직의 벡터 인덱스에서 특정 articleId와 연결된 모든 벡터를 삭제하는 테스트 엔드포인트입니다.

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨) articleId `string` (필수) 벡터를 삭제할 articleId dryRun `string` (선택) true이면 실제로 삭제하지 않고 삭제될 항목만 표시합니다

엔드포인트

DELETE /api/llm/test/vector-delete-article

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/llm/test/vector-delete-article \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 인덱스를 나열하여 Vector SDK 테스트

Vector SDK 연결을 확인하고 벡터 버킷의 모든 인덱스를 나열하는 테스트 엔드포인트

엔드포인트

GET /api/llm/test/vector-indices

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/llm/test/vector-indices \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직의 Vector 인덱스 초기화

현재 사용자 조직의 Vector 버킷과 인덱스를 생성합니다

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨)

엔드포인트

POST /api/llm/test/vector-init-index

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/llm/test/vector-init-index \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 articleId의 모든 벡터 메타데이터 가져오기

벡터 인덱스에서 특정 articleId의 모든 벡터 청크와 해당 메타데이터를 가져오는 테스트 엔드포인트입니다. 문서가 어떻게 청크로 분할되어 저장되는지 확인할 때 유용합니다. 필터링은 벡터 저장소 서비스에서 처리합니다.

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨) articleId `string` (필수) 벡터 메타데이터를 가져올 문서 ID

엔드포인트

GET /api/llm/test/vector-metadata-by-article

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/llm/test/vector-metadata-by-article \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

벡터 인덱스에서 메타데이터와 함께 최근 벡터 가져오기

현재 사용자 조직의 벡터 인덱스에서 가장 최근 벡터 10개를 메타데이터와 함께(벡터 데이터 제외) 가져오는 테스트 엔드포인트입니다. 메타데이터 구조를 확인할 때 유용합니다.

매개변수

organisationId `string` (선택) 조직 ID(제공하지 않으면 자동으로 감지됨) limit `string` (선택) 반환할 최근 벡터 수(최대 100)

엔드포인트

GET /api/llm/test/vector-recent

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/llm/test/vector-recent \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Marketing Manager/Designer용 에셋을 S3 Storage에 업로드합니다.

매개변수

file `string` (선택) 업로드할 파일/에셋의 이름입니다.

엔드포인트

POST /api/marketing/design/static/download

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/marketing/design/static/download \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

에셋 관리자에 로드할 개별 에셋을 JSON 형식으로 반환합니다.

매개변수

id `string` (필수) 가져올 에셋의 ID입니다. organisationId `string` (필수) 에셋이 속한 시설의 조직 ID입니다.

엔드포인트

GET /api/marketing/assets/get/{id}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/assets/get/{id} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 디자인 에셋을 반환합니다.

매개변수

body `string` (필수) 저장할 시설 데이터의 JSON 객체입니다. organisationId `string` (필수) 에셋이 속한 시설의 조직 ID입니다. useCache `string` (선택) search `string` (선택) 이름 또는 태그로 에셋을 필터링할 검색어입니다. brand `string` (선택) 에셋을 필터링할 브랜드입니다. tag `string` (선택) 에셋을 필터링할 태그입니다.

엔드포인트

GET /api/marketing/assets/get

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/assets/get \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직의 마케팅 인쇄 에셋을 한 페이지씩 반환합니다. 관련성 검색과 페이지 기반 페이지 매김(전체 건수 포함)에 Algolia를 사용하며, Algolia를 사용할 수 없으면 DynamoDB로 대체합니다.

매개변수

organisationId `string` (필수) 에셋이 속한 시설의 조직 ID입니다. search `string` (선택) 이름 또는 태그로 에셋을 필터링할 검색어입니다. brand `string` (선택) 에셋을 필터링할 브랜드입니다. tag `string` (선택) 에셋을 필터링할 태그입니다. page `string` (선택) 가져올 페이지 번호(0부터 시작)입니다. limit `string` (선택) 페이지당 에셋 수(최대 300)입니다. useCache `string` (선택) false이면 Algolia를 거치지 않고 DynamoDB를 직접 조회합니다.

엔드포인트

GET /api/marketing/assets

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/assets \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

에셋 관리자를 통해 업로드된 사용 가능한 에셋 목록을 반환합니다.

매개변수

organisationId `string` (필수)

엔드포인트

GET /api/marketing/assets/list

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/assets/list \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

에셋을 추가/저장합니다.

매개변수

body `string` (필수) 저장할 시설 데이터의 JSON 객체입니다. organisationId `string` (필수) 에셋이 속한 시설의 조직 ID입니다.

엔드포인트

PUT /api/marketing/assets/save

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/marketing/assets/save \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Marketing Manager/Designer용 에셋을 S3 Storage에 업로드합니다.

매개변수

file `string` (선택) 업로드할 파일/에셋의 이름입니다. organisationId `string` (선택) 에셋이 속한 조직의 ID입니다.

엔드포인트

POST /api/marketing/assets/upload

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/marketing/assets/upload \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직의 모든 사용자 지정 페이지 목록을 반환합니다.

매개변수

organisationId `string` (필수) 사용자 지정 페이지를 반환할 조직의 내부 ID입니다.

엔드포인트

GET /api/marketing/custom-pages

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/custom-pages \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직의 사용자 지정 페이지를 업서트합니다.

매개변수

organisationId `string` (필수) 사용자 지정 페이지를 반환할 조직의 내부 ID입니다. body `object` (필수) 업서트할 사용자 지정 페이지 데이터입니다.

엔드포인트

PUT /api/marketing/custom-pages

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/marketing/custom-pages \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 모든 사용자 지정 페이지 목록을 반환합니다.

매개변수

facilityId `string` (필수) 사용자 지정 페이지를 반환할 시설의 내부 ID입니다.

엔드포인트

GET /api/facilities/{facilityId}/marketing/custom-pages

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/marketing/custom-pages \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 시설 ID에 대해 내보내거나 렌더링된 모든 디자인을 반환합니다.

매개변수

club `string` (필수) 요청하는 시설의 내부 ID입니다. sort `string` (선택) 디자인 정렬 기준입니다. 'oldest', 'newest' 또는 'design'을 지원합니다.

엔드포인트

GET /api/marketing/designs/{club}/exports

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/designs/{club}/exports \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

편집기에 로드할 디자인의 개별 HTML 콘텐츠를 JSON 형식으로 반환합니다.

매개변수

id `string` (필수) 가져올 디자인의 ID입니다.

엔드포인트

GET /api/marketing/designs/get/{id}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/designs/get/{id} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

마케팅 및 인쇄 디자인과 디자인 템플릿의 입력 매핑 목록을 반환합니다

매개변수

clubId `string` (필수) 요청하는 시설의 내부 ID입니다. availableFeatures `string` (선택) 특정 기능이 있는 모든 항목을 반환합니다 brand `string` (선택) 브랜드별로 디자인을 필터링합니다 features `string` (선택) 기능을 기준으로 결과를 필터링합니다

엔드포인트

GET /api/marketing/designs/input-mapping/{clubId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/designs/input-mapping/{clubId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

허브의 마케팅/인쇄 편집기에서 만든 디자인(Print Designs)에 사용할 수 있는, 지정한 시설의 사용 가능한 디자인 목록을 반환합니다.

매개변수

club `string` (필수) 요청하는 시설의 내부 ID입니다. designAdmin `string` (선택) 모든 디자인 데이터를 반환합니다(관리자 보기이며 사용자가 관리자여야 함). brand `string` (선택) 브랜드별로 디자인을 필터링합니다

엔드포인트

GET /api/marketing/designs/{club}/list

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/designs/{club}/list \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시스템이 모든 디자인 썸네일과 미리 보기를 강제로 렌더링/다시 렌더링하도록 합니다(주로 S3 등의 '업스트림' 에셋을 변경한 경우에 사용)... **참고** 이 함수는 X분에 한 번만 호출할 수 있습니다(렌더링이 이미 실행 중이면 호출할 수 없습니다). 이는 모든 디자인을 렌더링하면서 서버에 과도한 부하가 걸리지 않도록 하기 위한 것입니다...

엔드포인트

GET /api/marketing/designs/render-all-thumbnails

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/designs/render-all-thumbnails \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Dynamic Design 렌더링을 시작합니다

매개변수

body `string` (필수) 디자인 렌더링 프로세서로 보낼 시설 데이터의 JSON 객체입니다...

엔드포인트

POST /api/marketing/designs/dynamic/render-design

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/marketing/designs/dynamic/render-design \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

디자인을 추가/저장/업데이트합니다.

매개변수

body `string` (필수) 저장할 시설 데이터의 JSON 객체입니다.

엔드포인트

PUT /api/marketing/designs/{club}/save

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/marketing/designs/{club}/save \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

로드할 개별 정적 디자인을 JSON 형식으로 반환합니다

매개변수

id `string` (필수) 가져올 정적 디자인의 ID입니다.

엔드포인트

GET /api/marketing/designs/static/get/{id}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/designs/static/get/{id} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

정적 디자인 템플릿을 추가/저장/업데이트합니다.

매개변수

body `string` (필수) 저장할 시설 데이터의 JSON 객체입니다.

엔드포인트

PUT /api/marketing/designs/static/{club}/save

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/marketing/designs/static/{club}/save \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자가 설정한 변수를 시스템에서 제거합니다.

매개변수

club `string` (필수) 요청하는 시설의 내부 ID입니다. body `string` (필수) 제거할 변수 ID가 포함된 JSON입니다.

엔드포인트

DELETE /api/marketing/variables/{club}/delete

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/marketing/variables/{club}/delete \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

허브의 마케팅/인쇄 편집기에서 만든 디자인(Print Designs)에 사용할 수 있는, 지정한 시설의 사용 가능한 변수 목록을 반환합니다.

매개변수

club `string` (필수) 요청하는 시설의 내부 ID입니다.

엔드포인트

GET /api/marketing/variables/{club}/list

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/marketing/variables/{club}/list \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 시설에 사용자 기반 '변수'를 새로 하나 만듭니다.

매개변수

club `string` (필수) 요청하는 시설의 내부 ID입니다. body `string` (필수) 새 변수의 JSON 객체입니다.

엔드포인트

POST /api/marketing/variables/{club}/new

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/marketing/variables/{club}/new \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

객체 배열을 통해 시스템에서 하나 이상의 디자인 변수를 추가/저장/업데이트합니다.

매개변수

club `string` (필수) 요청하는 시설의 내부 ID입니다. body `string` (필수) 추가/업데이트할 하나 이상의 JSON 객체 배열입니다(하나의 API 요청으로 여러 항목/객체를 저장할 수 있습니다).

엔드포인트

PUT /api/marketing/variables/{club}/save

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/marketing/variables/{club}/save \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

로그인한 사용자의 MCP 문서 매니페스트를 반환합니다

앱 내 `/mcp-docs` 페이지에 사용됩니다. MCP 서버 URL, 지원되는 인증 헤더, 호출자의 신원/관리자 플래그, 필터링된 도구 목록을 반환합니다(`/mcp/tools/list`와 동일하게 필터링되므로 문서 페이지에는 호출자가 실제로 사용할 수 없는 도구가 표시되지 않습니다).

엔드포인트

GET /api/mcp/docs-manifest

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/mcp/docs-manifest \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 약관을 만듭니다.

매개변수

body `object` (필수) 저장할 시설 데이터의 JSON 객체입니다.

엔드포인트

POST /api/member-agreements/contracts-tna/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/member-agreements/contracts-tna/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

약관 목록을 반환합니다.

엔드포인트

GET /api/member-agreements/contracts-tna/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/member-agreements/contracts-tna/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 약관을 삭제합니다.

엔드포인트

DELETE /api/member-agreements/contracts-tna/:club/:id

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/member-agreements/contracts-tna/:club/:id \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 약관을 반환합니다.

엔드포인트

GET /api/member-agreements/contracts-tna/:club/:id

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/member-agreements/contracts-tna/:club/:id \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 약관을 업데이트합니다.

매개변수

body `object` (필수) 저장할 시설 데이터의 JSON 객체입니다.

엔드포인트

PATCH /api/member-agreements/contracts-tna/:club/:id

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/member-agreements/contracts-tna/:club/:id \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 기본 약관을 가져옵니다.

매개변수

body `object` (필수) 저장할 시설 데이터의 JSON 객체입니다.

엔드포인트

GET /api/member-agreements/default-tna/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/member-agreements/default-tna/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 기본 약관을 설정합니다.

매개변수

body `object` (필수) 저장할 시설 데이터의 JSON 객체입니다.

엔드포인트

POST /api/member-agreements/default-tna/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/member-agreements/default-tna/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

전역 또는 지역 약관 목록을 반환합니다.

엔드포인트

GET /api/member-agreements/global-tna/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/member-agreements/global-tna/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

계약이 있는 회원 목록을 반환합니다.

엔드포인트

GET /api/member-agreements/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/member-agreements/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

트레이닝 캠프 앱용 시즌별 시설 회원 목록을 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. season `string` (선택) 필터링할 트레이닝 캠프 시즌입니다. userIds `string` (선택) 필터링할 사용자 ID 배열입니다. useCache `string` (선택) 캐시 사용 여부입니다. isUserMemberInfo `string` (선택) 활성화하면 userIds를 기준으로 데이터를 필터링하고(사용자 ID 하나만 사용하는 것을 권장) 리더보드 및 사용자 기본 설정 등 필요한 데이터를 포함합니다.

엔드포인트

GET /api/members-leads/trainingcamp/club/season-members/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/members-leads/trainingcamp/club/season-members/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

여러 운동 예약 리드를 삭제합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. body `string` (필수)

엔드포인트

DELETE /api/members-leads/workout-booking/club/leads/{club}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/members-leads/workout-booking/club/leads/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 운동 예약 리드 목록을 반환합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. all `string` (선택) 모든 리드를 표시할지, 예정된 리드만 표시할지 지정합니다.

엔드포인트

GET /api/members-leads/workout-booking/club/leads/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/members-leads/workout-booking/club/leads/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

운동 예약 리드를 업데이트합니다.

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다. body `string` (필수)

엔드포인트

PUT /api/members-leads/workout-booking/club/leads/{club}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/members-leads/workout-booking/club/leads/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

운동 예약 리드의 플래그 상태를 전환합니다.

매개변수

club `string` (필수) 클럽의 내부 ID입니다. body `string` (필수)

엔드포인트

PATCH /api/members-leads/workout-booking/club/leads/{club}/flag

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/members-leads/workout-booking/club/leads/{club}/flag \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 유효 모듈 가져오기

계층 구조(시설 기본 설정 → 브랜드 모듈 → 조직 모듈)를 확인하여 시설에서 사용할 수 있는 모든 모듈을 반환합니다. 성능을 위해 결과는 Redis에 캐시됩니다.

매개변수

facilityId `string` (필수) 모듈을 확인할 시설 ID

엔드포인트

GET /api/facilities/{facilityId}/modules

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/modules \
  -H "x-api-key: YOUR_API_KEY"

응답

[]

모듈 카탈로그와 사이드 메뉴 렌더링 구성을 반환합니다. 프런트엔드 렌더러가 사용자별 표시 여부를 결정할 수 있도록 전체 모듈 목록이 반환되며, ACL은 여전히 `auth.checkModuleAccess()`를 통해 서버 측에서 적용됩니다.

엔드포인트

GET /api/modules

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/modules \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 카테고리를 가져옵니다.

엔드포인트

GET /api/notification/categories

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/notification/categories \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

확인된 알림을 삭제합니다.

엔드포인트

DELETE /api/club/notification/consumed/:club

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/club/notification/consumed/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 메시지를 만듭니다.

엔드포인트

POST /api/club/notification/consumed/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/club/notification/consumed/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

확인된 알림 배열을 반환합니다.

엔드포인트

GET /api/club/notification/consumed/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/notification/consumed/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 메시지를 삭제합니다.

엔드포인트

DELETE /api/club/notification/messages/:club

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/club/notification/messages/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 메시지 배열을 반환합니다.

엔드포인트

GET /api/club/notification/messages/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/notification/messages/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 메시지를 업데이트합니다.

엔드포인트

PATCH /api/club/notification/messages/:club

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/club/notification/messages/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 메시지를 만듭니다.

매개변수

body `string` (필수)

엔드포인트

POST /api/club/notification/messages/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/club/notification/messages/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설별 알림 조회자를 가져옵니다.

엔드포인트

POST /api/club/notification/viewers/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/club/notification/viewers/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자별 알림 카테고리를 가져옵니다.

엔드포인트

GET /api/club/notification/user-categories/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/notification/user-categories/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

알림 메시지를 만듭니다.

엔드포인트

POST /api/notification/webhook

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/notification/webhook \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

HTML5 푸시용 VAPID 공개 키 가져오기

브라우저 푸시 구독을 만드는 데 사용하는 VAPID 공개 키를 반환합니다.

엔드포인트

GET /html5-push/vapid-public-key

요청 예시

curl -X GET https://portal.hub.gymsystems.co/html5-push/vapid-public-key \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

HTML5 푸시 구독 저장 또는 업데이트

현재 사용자의 브라우저 푸시 구독을 저장합니다.

요청 본문

엔드포인트

POST /html5-push/subscribe

요청 예시

curl -X POST https://portal.hub.gymsystems.co/html5-push/subscribe \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

HTML5 푸시 구독 삭제

현재 사용자의 브라우저 푸시 구독을 제거합니다.

요청 본문

엔드포인트

POST /html5-push/unsubscribe

요청 예시

curl -X POST https://portal.hub.gymsystems.co/html5-push/unsubscribe \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

호출한 사용자의 위치 온보딩 상태 가져오기

시설의 두 가지 온보딩 부분, 즉 설정(세부 정보 + 제품 선택, 시설 기본 설정에 저장됨)과 결제(SaaS 청구 결제 설정 레코드에서 실시간으로 파생됨), 그리고 앱 셸이 접근 제한에 사용하는 호출자별 `required` 플래그를 반환합니다. 기술 스택 위치에만 해당하며, 비즈니스 스택 위치는 항상 required=false를 반환합니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/onboarding/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/onboarding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 진행 중인 온보딩 마법사 진행 상황 저장

마법사의 일부 상태(제품 선택, "Other" 자유 텍스트, 검토한 비즈니스 세부 정보, 현재 단계)를 저장하므로 새로 고치거나 중단해도 사용자가 멈춘 지점부터 다시 시작할 수 있습니다. 완료 표시는 하지 않습니다. complete 엔드포인트를 참조하십시오.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/onboarding/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/onboarding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

온보딩 마법사용 AI 미리 채우기 제안 생성

기존 시설/브랜드/조직 컨텍스트를 사용하여 시설 세부 정보(소개 문구, 정리된 연락처 필드), 제안 제품 선택, 짧은 맞춤형 팁을 제안합니다. 결과는 Redis에 7일 동안 캐시됩니다. 제안은 참고용일 뿐이며, 클라이언트는 이를 편집 가능한 검토 양식에 표시합니다. 항상 200으로 응답하며, AI를 사용할 수 없으면 `suggestions`가 null이 되어 마법사가 정상적으로 기능을 축소합니다.

매개변수

facilityId `string` (필수)

엔드포인트

POST /api/onboarding/{facilityId}/ai-prefill

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/onboarding/{facilityId}/ai-prefill \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

위치 온보딩의 설정 부분 완료

확인된 선택 항목/세부 정보를 검증하고, 비즈니스 세부 정보를 시설 레코드에 저장하며, 제품 선택을 바탕으로 시설 기술 메뉴 레이아웃을 초기화하고(사용자 지정 레이아웃이 이미 있는 경우 제외), 설정 완료를 기록합니다. 결제 부분은 의도적으로 여기서 완료할 수 없습니다. 결제 부분은 SaaS 청구 결제 설정 레코드에서 실시간으로 파생되므로, 이 엔드포인트를 호출해도 필수 카드 요구 사항을 우회할 수 없습니다. 갱신된 상태를 반환합니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/onboarding/{facilityId}/complete

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/onboarding/{facilityId}/complete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설에 대해 선언된 파트너 통합 작업 실행

파트너 레코드(ph-partners.actions[])에 선언된 "Run integration" 작업을 시설 범위로 실행합니다. Redis 단일 실행 잠금으로 동일한 작업+시설에 대한 수동 실행이 동시에 이루어지지 않도록 합니다.

매개변수

partnerId `string` (필수) actionId `string` (필수)

요청 본문

엔드포인트

POST /api/partners/{partnerId}/actions/{actionId}/run

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/partners/{partnerId}/actions/{actionId}/run \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

파트너 통합 작업의 실행 상태 읽기

현재 수동 실행이 진행 중인지 여부(단일 실행 잠금 보유)와 마지막으로 요청된 실행을 반환하며, 설정 버튼이 폴링하는 데 사용합니다.

매개변수

partnerId `string` (필수) actionId `string` (필수) facilityId `string` (필수)

엔드포인트

GET /api/partners/{partnerId}/actions/{actionId}/status

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/partners/{partnerId}/actions/{actionId}/status \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

브랜드의 모든 파트너 구성 가져오기

매개변수

brandId `string` (필수) 브랜드 ID

엔드포인트

GET /api/partners/brand-config/{brandId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/partners/brand-config/{brandId} \
  -H "x-api-key: YOUR_API_KEY"

응답

[]

브랜드 파트너 구성 만들기 또는 업데이트

매개변수

body `object` (필수)

엔드포인트

PUT /api/partners/brand-config

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/partners/brand-config \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

GymMaster 통합 데이터를 facility-partner-config로 마이그레이션

gymMasterAPI 및 gymMasterDomain 필드가 있는 모든 시설을 조회하고 해당 facility-partner-config 레코드를 생성/업데이트합니다. 일회성 마이그레이션 엔드포인트입니다.

매개변수

partnerId `string` (필수) 마이그레이션되는 모든 레코드에 사용할 GymMaster 파트너 ID dryRun `boolean` (선택) true이면 데이터베이스에 기록하지 않고 마이그레이션될 항목만 보고합니다

엔드포인트

GET /api/partners/migrate-gymmaster

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/partners/migrate-gymmaster \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직에 대해 파트너를 활성화합니다.

매개변수

partnerId `string` (필수) 파트너의 ID

엔드포인트

POST /api/partners/organisation/enable

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/partners/organisation/enable \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직 파트너 목록을 반환합니다. 조직 관리자에게는 자신의 조직 파트너만 표시됩니다.

엔드포인트

GET /api/partners/organisation

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/partners/organisation \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직 파트너를 제거합니다.

매개변수

keyId `string` (필수) 조직 파트너의 키 ID organisationId `string` (필수) 파트너의 조직 ID

엔드포인트

DELETE /api/partners/organisation/{keyId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/partners/organisation/{keyId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

조직 파트너의 접근 모드와 모듈을 업데이트합니다.

매개변수

keyId `string` (필수) 조직 파트너의 키 ID organisationId `string` (필수) 파트너의 조직 ID partnerId `string` (필수) 파트너 ID accessMode `string` (필수) 파트너의 접근 모드 modules `string` (선택) LIMITED 접근 모드의 모듈 목록

엔드포인트

PUT /api/partners/organisation/update-access

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/partners/organisation/update-access \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 체크인 만들기

체크인 객체 배열을 받아 처리하도록 Partner API로 전달합니다. 요청당 최대 25개의 체크인을 처리할 수 있습니다.

요청 본문

엔드포인트

POST /api/partners/check-ins

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/partners/check-ins \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 파트너 구성 삭제

시설의 파트너 통합 구성을 제거합니다

매개변수

facilityId `string` (필수) 시설 ID(club ID) partnerId `string` (필수) 파트너 ID

엔드포인트

DELETE /api/partners/facility-config/{facilityId}/{partnerId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/partners/facility-config/{facilityId}/{partnerId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 모든 파트너 구성 목록

지정한 시설에 구성된 모든 파트너 통합을 반환합니다

매개변수

facilityId `string` (필수) 시설 ID(club ID)

엔드포인트

GET /api/partners/facility-config/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/partners/facility-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 파트너 구성 만들기 또는 업데이트

시설의 파트너 통합 구성을 업서트합니다

요청 본문

엔드포인트

POST /api/partners/facility-config

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/partners/facility-config \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

memberId로 회원 삭제

memberId를 사용하여 기존 회원 레코드를 삭제합니다.

매개변수

memberId `string` (필수) 회원의 고유 식별자

엔드포인트

DELETE /api/partners/members/{memberId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/partners/members/{memberId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

memberId로 회원 업데이트

memberId를 사용하여 기존 회원 레코드를 업데이트합니다.

매개변수

memberId `string` (필수) 회원의 고유 식별자

요청 본문

엔드포인트

PUT /api/partners/members/{memberId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/partners/members/{memberId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

회원 동기화 작업 상태 가져오기

POST /api/partners/members 또는 DELETE /api/partners/members/{memberId}를 통해 시작된 비동기 회원 생성/삭제 작업의 현재 상태를 반환합니다. 프런트엔드는 기존의 목록 폴링 + 이름 일치 흐름 대신 이 엔드포인트를 폴링합니다. 참고: 행 수준 partnerId/facilityId 범위 지정은 멀티테넌트 격리 규칙에 따라 필수이지만 Phase 3a.1 보안 강화 PR로 연기되었습니다. operationId는 128비트 UUID이며 이 경로는 이미 `external-integrations` 모듈 접근 권한으로 제한됩니다. 유효한 operationId와 관리자 모듈 접근 권한이 있는 사람은 누구나 상태를 조회할 수 있습니다.

매개변수

operationId `string` (필수) POST/DELETE에서 반환된 UUID

엔드포인트

GET /api/partners/members/operations/{operationId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/partners/members/operations/{operationId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 회원 만들기 또는 업데이트

회원 객체 배열을 받아 처리하도록 Partner API로 전달합니다. 요청당 최대 25명의 회원을 처리할 수 있습니다.

요청 본문

엔드포인트

POST /api/partners/members

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/partners/members \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 멤버십 플랜 만들기 또는 업데이트

멤버십 플랜 객체 배열을 받아 처리하도록 Partner API로 전달합니다. 요청당 최대 25개의 멤버십 플랜을 처리할 수 있습니다.

요청 본문

엔드포인트

POST /api/partners/membership-plans

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/partners/membership-plans \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

새 역할을 만듭니다

매개변수

body `string` (필수) 역할 객체

엔드포인트

POST /api/roles

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/roles \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 역할 목록을 반환합니다

엔드포인트

GET /api/roles

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/roles \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

ID로 역할을 삭제합니다

엔드포인트

DELETE /api/roles/{roleId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/roles/{roleId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

ID로 역할을 업데이트합니다

매개변수

body `string` (필수) 역할 객체

엔드포인트

PUT /api/roles/{roleId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/roles/{roleId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

SaaS 청구 인보이스에 새 추가 항목 만들기

매개변수

organisationId `string` (선택) 추가 항목을 만들 조직 ID body `string` (선택) 요청 본문

엔드포인트

POST /api/saas-billing/additional-line-items

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/saas-billing/additional-line-items \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

SaaS 청구 인보이스의 추가 항목 목록을 반환합니다

매개변수

organisationId `string` (필수) 조직 ID

엔드포인트

GET /api/saas-billing/additional-line-items

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/additional-line-items \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 SaaS 청구 인보이스에 대한 추가 항목 목록을 반환합니다

엔드포인트

GET /api/clubs/{clubId}/saas-billing/additional-line-items

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/saas-billing/additional-line-items \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

SaaS 청구 인보이스의 추가 항목을 업데이트합니다

매개변수

itemId `string` (필수) 업데이트할 추가 항목의 ID body `string` (필수) 요청 본문

엔드포인트

PUT /api/saas-billing/additional-line-items/{itemId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/saas-billing/additional-line-items/{itemId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Your Rates용 Cloud Agent 통합 시간당 요금

제공되는 Cloud Agent 크기를 하나로 합산된 시간당 가격(호스팅 + 소프트웨어)과 함께 반환합니다. 세부 내역은 포함되지 않습니다. usedPlans는 이 시설에서 지난 30일 동안 실행한 SKU입니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/cloud-agent-rates

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/cloud-agent-rates \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

가져온 월별 보고서 삭제

매개변수

club `string` (선택) 클럽 ID reportId `string` (선택) 보고서 ID

엔드포인트

DELETE /api/saas-billing/extended-access/monthly-usage-report/{reportId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/saas-billing/extended-access/monthly-usage-report/{reportId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 최신 CCTV 스토리지 보고서 가져오기

저장된 청구 로그(최근 31일 이내)에서 시설의 가장 최근 일별 CCTV 스토리지 스냅샷을 반환합니다. totalStorage, 날짜 및 스토리지 관련 요금이 포함됩니다.

매개변수

club `string` (필수) 클럽 ID

엔드포인트

GET /api/saas-billing/extended-access/latest-cctv-storage-report/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/latest-cctv-storage-report/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지정한 기간에 대한 시설의 PDF 인보이스를 반환합니다.

매개변수

club `string` (선택) 클럽 ID month `string` (선택) 보고서 월(숫자 형식). 1 = 1월, 2 = 2월 등 year `string` (선택) 보고서 연도(숫자 형식). 예: 2021

엔드포인트

GET /api/saas-billing/extended-access/monthly-usage-report/:club/invoice

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/monthly-usage-report/:club/invoice \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

선택한 사용 월의 플랫폼 인보이스 PDF를 ZIP으로 묶은 파일입니다. 단일 .../invoice 엔드포인트의 일괄 버전으로, Billing & Cost Management 애플릿의 Invoices & Receipts 탭에서 여러 항목을 선택해 다운로드하는 기능에 사용됩니다.

매개변수

club `string` (선택) 클럽 ID months `string` (선택) 쉼표로 구분된 YYYY-MM 형식의 사용/보고서 월(최대 24개)

엔드포인트

GET /api/saas-billing/extended-access/monthly-usage-report/{club}/invoices.zip

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/monthly-usage-report/{club}/invoices.zip \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

한 번의 호출로 여러 사용 월의 월별 사용량 보고서를 반환합니다. Billing & Cost Management 애플릿의 비용 기록 차트와 전월 대비 변화량에 사용됩니다. 아직 사용량이 없는 월은 report: null을 반환합니다(단일 월 엔드포인트의 404 → $0 UI와 동일).

매개변수

club `string` (선택) 클럽 ID months `string` (선택) 쉼표로 구분된 YYYY-MM 형식의 사용 월(최대 12개)

엔드포인트

GET /api/saas-billing/extended-access/monthly-usage-report/{club}/batch

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/monthly-usage-report/{club}/batch \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 월별 보고서를 가져옵니다.

매개변수

club `string` (선택) 클럽 ID

엔드포인트

PUT /api/saas-billing/extended-access/usage-report/:club

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/saas-billing/extended-access/usage-report/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 시설의 지난 30일간 CCTV 사용량 CSV 보고서를 반환합니다.

엔드포인트

GET /api/saas-billing/extended-access/usage-report/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/usage-report/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 해당 월 일별 보고서를 모두 나열합니다.

매개변수

club `string` (선택) 클럽 ID month `string` (선택) 보고서 월(숫자 형식). 1 = 1월, 2 = 2월 등 year `string` (선택) 보고서 연도(숫자 형식). 예: 2021

엔드포인트

GET /api/saas-billing/extended-access/monthly-usage-report/{club}/daily-reports

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/monthly-usage-report/{club}/daily-reports \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

관리자를 위해 가져온 월별 보고서 목록을 반환합니다

매개변수

organisationId `string` (필수) 조직 ID

엔드포인트

GET /api/saas-billing/extended-access/usage-report/imported

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/usage-report/imported \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 시설의 지난 30일간 CCTV 사용량 CSV 보고서를 반환합니다.

매개변수

club `string` (선택) 클럽 ID month `string` (선택) 보고서 월(숫자 형식). 1 = 1월, 2 = 2월 등 year `string` (선택) 보고서 연도(숫자 형식). 예: 2021

엔드포인트

GET /api/saas-billing/extended-access/monthly-usage-report/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/monthly-usage-report/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 기간별 사용량 보고서를 반환합니다.

매개변수

club `string` (선택) 클럽 ID periodStart `string` (선택) YYYY-MM-DD 형식의 기간 시작일 periodEnd `string` (선택) YYYY-MM-DD 형식의 기간 종료일

엔드포인트

GET /api/saas-billing/extended-access/periodical-usage-report/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/extended-access/periodical-usage-report/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

여러 문서 유형(사용 월별 플랫폼 인보이스, SaaS 지갑 충전 영수증, Model Router 충전 영수증)이 섞인 청구 문서 PDF를 하나의 ZIP으로 묶은 파일입니다. 통합 Invoices & Receipts 탭을 위한, 유형별 invoices.zip / receipts.zip 엔드포인트의 일괄 버전입니다. 요청한 모든 월/ID는 시설이 소유한 문서여야 하며, 잘못된 값이 하나라도 있으면 전체 묶음이 실패합니다.

매개변수

clubID `string` (필수) invoiceMonths `string` (선택) 쉼표로 구분된 YYYY-MM 형식의 사용 월 walletIds `string` (선택) 쉼표로 구분된 SaaS 지갑 충전 거래 ID aiIds `string` (선택) 쉼표로 구분된 Model Router 충전 거래 ID

엔드포인트

GET /api/clubs/{clubID}/saas-billing/documents.zip

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/documents.zip \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

월별 레코드에 메모 추가

매개변수

recordID `string` (선택) 가져올 레코드의 ID note `string` (선택) 레코드에 추가할 메모

엔드포인트

POST /api/saas-billing/monthly-records/{recordID}/notes

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/saas-billing/monthly-records/{recordID}/notes \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

SaaS 청구 월별 레코드 목록을 반환합니다

매개변수

club `string` (선택) 가져올 시설의 ID month `string` (선택) YYYY-MM 형식의 청구 월

엔드포인트

GET /api/saas-billing/monthly-records/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/monthly-records/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

실패했거나 3D Secure가 필요한 SaaS 청구 월별 레코드 목록을 반환합니다

매개변수

clubID `string` (선택) 실패한 월별 레코드를 가져올 시설의 ID

엔드포인트

GET /api/clubs/:clubID/saas-billing/flagged

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/:clubID/saas-billing/flagged \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 모든 SaaS 청구 월별 레코드(인보이스 원장)를 최신 청구 월부터 반환합니다. 관리자 전용 paginate-monthly-records 엔드포인트의 시설 범위 버전으로, Billing & Cost Management 애플릿의 고객용 "Invoices & Receipts" 탭에 사용됩니다.

매개변수

clubID `string` (선택) 월별 레코드를 나열할 시설의 ID

엔드포인트

GET /api/clubs/{clubID}/saas-billing/monthly-records

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/monthly-records \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

SaaS 청구 월별 레코드 목록을 반환합니다

매개변수

organisationId `string` (선택) 조직 ID month `string` (선택) MM 형식의 월입니다. year `string` (선택) YYYY 형식의 연도입니다. filters `string` (선택) Datatable에서 생성한 쿼리 문자열 필터입니다. order `string` (선택) Datatable에서 생성한 쿼리 문자열입니다.

엔드포인트

GET /api/saas-billing/monthly-records

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/monthly-records \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 실패한 결제 재시도

매개변수

clubID `string` (선택) 실패한 월별 레코드를 가져올 시설의 ID

엔드포인트

PUT /api/clubs/:clubID/saas-billing/retry-failed-payments

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/:clubID/saas-billing/retry-failed-payments \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

월별 레코드 업데이트

매개변수

recordID `string` (선택) 가져올 레코드의 ID status `string` (선택) 레코드를 업데이트할 상태

엔드포인트

PUT /api/saas-billing/monthly-records/{recordID}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/saas-billing/monthly-records/{recordID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

결제가 성공했는지 확인하고 레코드 상태를 업데이트합니다

매개변수

clubID `string` (선택) recordID `string` (선택) 가져올 레코드의 ID

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/monthly-records/{recordID}/validate

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/monthly-records/{recordID}/validate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 결제 수단을 추가합니다.

매개변수

clubID `string` (선택)

엔드포인트

POST /api/clubs/{clubID}/saas-billing/payment-settings/payment-methods

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings/payment-methods \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 결제 수단을 Stripe와 동기화합니다.

매개변수

clubID `string` (선택)

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/payment-settings/payment-methods

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings/payment-methods \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 지출 예산과 계산된 당월 누계(MTD)/예측값을 반환합니다.

매개변수

clubID `string` (선택)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/budget

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/budget \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 지출 예산을 생성/업데이트/삭제합니다.

매개변수

clubID `string` (선택) body `object` (선택)

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/budget

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/budget \
  -H "x-api-key: YOUR_API_KEY"

시설의 결제 설정에서 결제 수단을 삭제합니다.

매개변수

clubID `string` (선택) paymentMethodID `string` (선택)

엔드포인트

DELETE /api/clubs/{clubID}/saas-billing/payment-settings/payment-methods/{paymentMethodID}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings/payment-methods/{paymentMethodID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 결제 설정을 가져옵니다.

매개변수

clubID `string` (선택)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/payment-settings

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 결제 설정을 업데이트합니다.

매개변수

clubID `string` (선택) lockedOut `boolean` (선택) 시설의 시스템 접근을 잠글지 여부입니다. pauseBilling `boolean` (선택) 시설의 자동 청구를 일시 중지할지 여부입니다. customerID `string` (선택) 이 값을 추가하면 시설의 Stripe 고객 ID가 업데이트됩니다. deleteSourceID `string` (선택) Stripe에서 원본 고객을 삭제할지 여부입니다.

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/payment-settings

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

모든 시설의 가장 이른 청구 월을 가져옵니다.

매개변수

clubID `string` (선택)

엔드포인트

GET /api/saas-billing/payment-settings/earliest-billed-month

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/payment-settings/earliest-billed-month \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 청구 잠금을 해제할 수 있는 계정을 단계별로 나열합니다. 청구 모듈을 보유한 사용자가 먼저 표시되며, 해당 사용자가 없는 경우에만 대체로 조직 관리자가 표시됩니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/lockout-contacts

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/lockout-contacts \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시스템의 모든 시설을 페이지 단위로 조회하여 각 시설의 고객 ID를 반환합니다.

매개변수

clubID `string` (선택) organisationId `string` (선택) 조직 ID

엔드포인트

GET /api/saas-billing/payment-settings/customer-ids

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/payment-settings/customer-ids \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 기본 결제 수단을 설정합니다.

매개변수

clubID `string` (선택)

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/payment-settings/payment-methods/{paymentMethodID}/primary

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings/payment-methods/{paymentMethodID}/primary \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 청구 프로필을 업데이트합니다.

매개변수

clubID `string` (선택) invoiceEntity `string` (선택) billingContacts `string` (선택) KYC 연락처의 UUID 목록 ccEmails `string` (선택) 인보이스에 참조(CC)로 추가할 이메일 목록

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/payment-settings/billing-profile

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings/billing-profile \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 결제 수단을 업데이트합니다.

매개변수

clubID `string` (선택) cardID `string` (선택)

엔드포인트

PUT /api/clubs/{clubID}/saas-billing/payment-settings/payment-methods/{cardID}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/payment-settings/payment-methods/{cardID} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

CSV 내보내기용으로 해당되는 모든 제품 요금과 추가 항목을 시설별로 나누어 반환합니다. 사용자가 접근할 수 있는 모든 시설에 대해 전역/지역/시설 재정의 계층 구조를 확인합니다.

매개변수

organisationId `string` (필수) ACL용 조직 ID

엔드포인트

GET /api/saas-billing/charges-config/export

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/charges-config/export \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 대상의 요금 구성을 반환합니다

매개변수

clubId `string` (선택) 요금 구성을 가져올 시설의 시설 ID

엔드포인트

GET /api/saas-billing/charges-config/{clubId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/saas-billing/charges-config/{clubId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설이 속한 조직의 청구 요약입니다. 유효한 결제자 범위, 예약된 통합 청구 변경 사항, 호출자가 통합 청구 토글을 관리할 수 있는지 여부가 포함됩니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/org/summary

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/org/summary \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

통합된 조직 월별 레코드(명세서)를 시설별 세부 내역과 함께 최신순으로 반환합니다. 조직의 첫 통합 청구 월이 확정될 때까지는 비어 있습니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/org/monthly-records

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/org/monthly-records \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

선불 지갑 요약입니다. 잔액, 당월 누계 사용량 차감액, 자동 충전 구성, 청구 방법이 포함됩니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/wallet

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

지갑 원장(최신순)입니다. 조직 범위 지갑에는 모든 시설의 행이 포함됩니다(각 행에는 원래 시설의 clubID가 포함됨).

매개변수

clubID `string` (필수) limit `string` (선택) types `string` (선택) 쉼표로 구분된 거래 유형 from `string` (선택) to `string` (선택) cursor `string` (선택) 이전 페이지의 nextCursor

엔드포인트

GET /api/clubs/{clubID}/saas-billing/wallet/transactions

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/transactions \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

단일 지갑 거래(충전 및 크레딧)에 대한 브랜드 PDF 영수증입니다.

매개변수

clubID `string` (필수) txId `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/wallet/transactions/{txId}/receipt.pdf

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/transactions/{txId}/receipt.pdf \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

선택한 지갑 충전 거래의 브랜드 PDF 영수증을 ZIP으로 묶은 파일입니다. 모든 ID는 이 시설 지갑에 속한 충전(카드 또는 인보이스)이어야 합니다. 사용량 차감 및 조정에는 영수증이 없으므로 거부됩니다.

매개변수

clubID `string` (필수) ids `string` (필수) 쉼표로 구분한 거래 ID(최대 50개)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/wallet/transactions/receipts.zip

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/transactions/receipts.zip \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

저장된 SaaS 청구 카드로 결제하여 선불 잔액을 추가합니다. 3DS가 필요한 경우 requires_action + clientSecret을 반환합니다.

매개변수

clubID `string` (필수) body `object` (선택)

엔드포인트

POST /api/clubs/{clubID}/saas-billing/wallet/topup

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/topup \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

애플릿이 3DS 인증을 완료한 후 지갑 충전을 마무리합니다. 멱등적입니다.

매개변수

clubID `string` (필수)

엔드포인트

POST /api/clubs/{clubID}/saas-billing/wallet/topup/confirm

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/topup/confirm \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 자동 충전 규칙을 업데이트합니다(청구 프로필 재정의 행에 저장됨).

매개변수

clubID `string` (필수) body `object` (선택)

엔드포인트

PATCH /api/clubs/{clubID}/saas-billing/wallet/auto-topup

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/auto-topup \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설 지갑의 충전 인보이스(인보이스 결제 수단)를 최신순으로 반환합니다.

매개변수

clubID `string` (필수)

엔드포인트

GET /api/clubs/{clubID}/saas-billing/wallet/invoices

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/invoices \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

참조 번호 결제 방식의 충전 인보이스를 요청합니다(인보이스 결제 수단 전용). 지갑당 대기 중인 인보이스는 최대 하나이며, 두 번째 요청은 기존 인보이스를 alreadyPending=true와 함께 반환합니다.

매개변수

clubID `string` (필수) body `string` (선택) { amountCents: number }

엔드포인트

POST /api/clubs/{clubID}/saas-billing/wallet/topup-invoice

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/saas-billing/wallet/topup-invoice \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 주문 목록을 반환합니다.

매개변수

facilityID `string` (선택)

엔드포인트

GET /api/store/facilities/:facilityID/orders

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/store/facilities/:facilityID/orders \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설에서 사용할 수 있는 제품 목록을 반환합니다.

매개변수

clubID `string` (필수) search `string` (선택) limit `string` (선택) page `string` (선택) 페이지 매김용 페이지 번호(1부터 시작)입니다.

엔드포인트

GET /api/store/clubs/{clubID}/products

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/store/clubs/{clubID}/products \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Stripe 레코드를 나열합니다.

매개변수

club `string` (필수) fromDate `string` (선택) Unix 타임스탬프 toDate `string` (선택) Unix 타임스탬프 socketID `string` (필수) 소켓 요청의 고유 식별자

엔드포인트

GET /api/club/{club}/stripe/records

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/{club}/stripe/records \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

결제 인텐트 취소

매개변수

club `string` (필수) paymentIntent `string` (선택)

엔드포인트

GET /api/club/{club}/stripe/payment-intent/:paymentIntent/cancel

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/{club}/stripe/payment-intent/:paymentIntent/cancel \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

임베디드 구성 요소용 Stripe Account Session 만들기

연결된 계정의 Stripe Account Session을 만듭니다. Connect 임베디드 구성 요소(분쟁, 지급, 계정 관리, 문서)를 초기화하는 데 사용하는 client_secret을 반환합니다.

요청 본문

엔드포인트

POST /api/stripe/account-session

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/stripe/account-session \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

연결된 계정의 Stripe KYC 페이지용 일회성 링크를 생성합니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/club/{club}/stripe/generate-kyc-token

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/{club}/stripe/generate-kyc-token \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

KYC 절차의 일부로 Stripe 연결 계정의 계정 세부 정보를 가져옵니다.

매개변수

club `string` (필수)

엔드포인트

GET /api/club/{club}/stripe/connect-account-details

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/club/{club}/stripe/connect-account-details \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 ID를 기준으로 모든 티켓 기록을 반환합니다

매개변수

club `string` (필수) 액세스할 클럽의 내부 ID입니다.

엔드포인트

GET /api/ticketing/clubtickets/{club}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ticketing/clubtickets/{club} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

부서 목록을 가져옵니다

엔드포인트

GET /api/ticketing/departments

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ticketing/departments \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

단일 티켓의 세부 정보를 가져옵니다

매개변수

user `string` (필수) 사용자의 이메일입니다. ticketNumber `string` (필수) 접근할 티켓의 6자리 ID입니다. club `string` (필수) 선택한 시설 ID입니다.

엔드포인트

GET /api/ticketing/ticket-details/:ticketNumber/:club

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ticketing/ticket-details/:ticketNumber/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

주제 목록을 가져옵니다

엔드포인트

GET /api/ticketing/topics

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ticketing/topics \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

현재 로그인한 사용자가 만든 모든 티켓을 가져옵니다. 이 값은 Google SSO 서비스에서 제공하는 헤더로 설정됩니다.

매개변수

user `string` (필수) 현재 로그인한 사용자의 이메일

엔드포인트

GET /api/ticketing/usertickets

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/ticketing/usertickets \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

새 티켓을 만듭니다

매개변수

club `string` (필수) 선택한 시설 ID입니다.

엔드포인트

POST /api/ticketing/clubticket/:club

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ticketing/clubticket/:club \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

새 티켓을 만듭니다

매개변수

subject `string` (필수) 티켓 제목입니다. message `string` (필수) 티켓의 전체 메시지입니다.

엔드포인트

POST /api/ticketing/userticket

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ticketing/userticket \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

기존 티켓에 대한 답글을 만듭니다

매개변수

subject `string` (필수) 티켓 제목입니다. message `string` (필수) 티켓의 전체 메시지입니다.

엔드포인트

POST /api/ticketing/user-reply

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/ticketing/user-reply \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자의 기본 설정을 가져옵니다

엔드포인트

GET /api/user-preferences

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/user-preferences \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자의 기본 설정을 업데이트합니다

매개변수

body `string` (필수)

엔드포인트

PUT /api/user-preferences

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/user-preferences \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자 비밀번호 변경

사용자의 비밀번호를 변경합니다. 사용자에게 전화번호가 있으면 OTP 인증이 필요하고, 없으면 전화번호를 추가해야 합니다.

요청 본문

엔드포인트

POST /api/user/change-password

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/change-password \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

사용자의 2FA 상태 확인

사용자에게 2FA가 활성화되어 있는지, 그리고 사용자 역할 중 2FA를 강제하는 역할이 있는지를 반환합니다

엔드포인트

GET /api/user/check-2fa-status

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/user/check-2fa-status \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

특정 모듈에 대해 사용자가 접근할 수 있는 조직, 시설 및 지역을 나열합니다.

매개변수

moduleId `string` (필수)

엔드포인트

POST /api/user/me/modules/{moduleId}/org-access

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/me/modules/{moduleId}/org-access \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

최종 사용자가 시설 '가입'을 요청하는 '연결 요청'을 만듭니다.

매개변수

body `string` (필수) 시스템에 추가할 새 클럽의 JSON 객체입니다.

엔드포인트

POST /api/user/linkclub

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/linkclub \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

사용자에게 권한이 부여된 모든 시설을 나열합니다.

엔드포인트

GET /api/user/listauthorised

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/user/listauthorised \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이중 채널 OTP 전송(이메일 + SMS)

사용자의 이메일 주소와 지정한 전화번호 모두에 OTP 코드를 보냅니다. 처음 전화번호를 인증하는 경우와 같이 보안 수준이 높은 작업에 사용됩니다. 이 엔드포인트는 OTP만 보내며 사용자 데이터를 수정하지 않습니다.

요청 본문

엔드포인트

POST /api/user/send-dual-otp

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/send-dual-otp \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

전화번호 또는 이메일로 OTP 전송

인증을 위해 사용자의 전화번호(SMS) 또는 이메일 주소로 OTP 코드를 보냅니다

요청 본문

엔드포인트

POST /api/user/send-otp

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/send-otp \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

사용자에게 유효한 민감 페이지 접근 권한이 있는지 확인

사용자에게 민감 페이지에 접근하기 위한 유효한 OTP 인증 세션이 있는지 반환합니다

엔드포인트

GET /api/user/sensitive-page-access

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/user/sensitive-page-access \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

OTP 확인 및 민감 페이지 접근 권한 부여

OTP 코드를 확인하고 유효하면 민감 페이지에 대한 1시간 접근 권한을 부여합니다

요청 본문

엔드포인트

POST /api/user/sensitive-page-access/verify

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/sensitive-page-access/verify \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

민감 페이지 접근 권한 취소(민감 페이지에서 로그아웃)

사용자의 현재 민감 페이지 접근 세션을 취소합니다

엔드포인트

POST /api/user/sensitive-page-access/revoke

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/sensitive-page-access/revoke \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

2FA 활성화 또는 비활성화

사용자의 2단계 인증을 활성화하거나 비활성화합니다. 전화번호와 OTP 인증이 필요합니다.

요청 본문

엔드포인트

POST /api/user/toggle-2fa

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/user/toggle-2fa \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

사용자 본인 프로필 업데이트

사용자가 자신의 프로필 정보(이름, 성, 전화번호)를 업데이트할 수 있습니다. 처음 전화번호를 추가할 때는 이중 채널 OTP 인증(이메일 및 SMS 코드 모두)이 필요합니다. 기존 전화번호를 변경할 때는 이메일 OTP만 필요합니다.

요청 본문

엔드포인트

PATCH /api/user/update-profile

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/user/update-profile \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

URL을 기준으로 아이콘을 가져옵니다.

엔드포인트

GET /api/website-icon

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/website-icon \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

비밀번호 보관함 항목 템플릿 목록

매개변수

organisationId `string` (선택) 모듈 접근 확인용 조직 컨텍스트

엔드포인트

GET /api/vault/templates

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/vault/templates \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

표시되는 비밀번호 보관함 항목 목록

매개변수

organisationId `string` (필수) scope `string` (선택)

엔드포인트

GET /api/vault/entries

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/vault/entries \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

비밀번호 보관함 항목 만들기

엔드포인트

POST /api/vault/entries

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/vault/entries \
  -H "x-api-key: YOUR_API_KEY"

비밀 값을 표시하지 않고 비밀번호 보관함 항목 가져오기

매개변수

entryId `string` (필수) organisationId `string` (필수)

엔드포인트

GET /api/vault/entries/{entryId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/vault/entries/{entryId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

비밀번호 보관함 항목 업데이트

엔드포인트

PUT /api/vault/entries/{entryId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/vault/entries/{entryId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

비밀번호 보관함 항목 삭제

엔드포인트

DELETE /api/vault/entries/{entryId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/vault/entries/{entryId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

선택한 숨김 또는 비밀 필드 표시

엔드포인트

POST /api/vault/entries/{entryId}/reveal

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/vault/entries/{entryId}/reveal \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

비밀번호 보관함 폴더 요약 목록

엔드포인트

GET /api/vault/folders

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/vault/folders \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

인증 코드가 있는 항목 목록

엔드포인트

GET /api/vault/authenticator

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/vault/authenticator \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

등록된 Workflow 노드 유형 목록

엔드포인트

GET /api/workflow-engine/node-types

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/node-types \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Workflow 블록에서 사용하는 시설 운영 시간 데이터 가져오기

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/facility-hours/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/facility-hours/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 브랜드가 적용된 Workflow 이메일 발신자 미리 보기

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/email-branding/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/email-branding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

트리거 구성용 시설 리소스 목록

매개변수

facilityId `string` (필수) resourceType `string` (필수)

엔드포인트

GET /api/workflow-engine/resources/{facilityId}/{resourceType}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/resources/{facilityId}/{resourceType} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Workflow 목록

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/workflows/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

비어 있지 않은 그래프로 초안 Workflow 만들기

편집기는 새 Workflow에 블록이 하나 이상 생길 때까지 로컬에 보관하므로, 처음 저장할 때 한 번의 호출로 그래프와 함께 Workflow를 만듭니다. `nodes`가 없는 본문은 저장되지 않고 거부됩니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

시설의 Workflow에서 사용할 수 있는 자격 증명 목록

시설 자체의 자격 증명과 해당 브랜드 또는 조직에서 공유된 자격 증명을 반환합니다. 시크릿은 반환되지 않으며, `hasValue`는 시크릿이 저장되어 있는지 여부만 알려 줍니다.

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/credentials/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/credentials/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Workflow 자격 증명 만들기

범위 수준은 `scopeType`에서 결정되며, 브랜드 및 조직 ID는 호출자에게서 받지 않고 시설을 기준으로 확인됩니다.

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/credentials/{facilityId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/credentials/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

시설 전체 Workflow 설정(실패 알림 수신자)

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/facility-settings/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/facility-settings/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설 전체 실패 알림 수신자 저장

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

PUT /api/workflow-engine/facility-settings/{facilityId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/workflow-engine/facility-settings/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Workflow 자격 증명 교체

`secret`이 비어 있으면 저장된 값이 유지되므로, 다시 입력하지 않고 자격 증명의 이름을 변경할 수 있습니다. 시크릿을 다시 읽어 올 수 있는 방법은 없습니다.

매개변수

facilityId `string` (필수) credentialId `string` (필수)

엔드포인트

PUT /api/workflow-engine/credentials/{facilityId}/{credentialId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/workflow-engine/credentials/{facilityId}/{credentialId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Workflow 자격 증명 삭제

스냅샷에는 참조만 저장되므로, 이를 참조하는 노드는 이미 게시된 Workflow를 포함하여 다음 호출 시 실패 시 차단(fail closed) 방식으로 실패합니다.

매개변수

facilityId `string` (필수) credentialId `string` (필수)

엔드포인트

DELETE /api/workflow-engine/credentials/{facilityId}/{credentialId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/workflow-engine/credentials/{facilityId}/{credentialId} \
  -H "x-api-key: YOUR_API_KEY"

Workflow 트리거의 웹훅 URL 가져오기

매개변수

facilityId `string` (필수) workflowId `string` (필수) nodeId `string` (필수)

엔드포인트

GET /api/workflow-engine/workflows/{facilityId}/{workflowId}/nodes/{nodeId}/webhook

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/nodes/{nodeId}/webhook \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Workflow 트리거의 웹훅 URL 교체

이전 URL을 즉시 무효화합니다.

매개변수

facilityId `string` (필수) workflowId `string` (필수) nodeId `string` (필수)

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/nodes/{nodeId}/webhook/rotate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/nodes/{nodeId}/webhook/rotate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

ID로 Workflow 가져오기

매개변수

facilityId `string` (필수) workflowId `string` (필수)

엔드포인트

GET /api/workflow-engine/workflows/{facilityId}/{workflowId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

초안 Workflow 만들기 또는 업데이트

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

PUT /api/workflow-engine/workflows/{facilityId}/{workflowId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Workflow 이름 및/또는 설명 업데이트

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

PATCH /api/workflow-engine/workflows/{facilityId}/{workflowId}

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Workflow 및 해당 버전 삭제

매개변수

facilityId `string` (필수) workflowId `string` (필수)

엔드포인트

DELETE /api/workflow-engine/workflows/{facilityId}/{workflowId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Workflow를 비활성 상태의 새 초안으로 복제

매개변수

facilityId `string` (필수) workflowId `string` (필수)

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/duplicate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/duplicate \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

현재 초안 게시(변경 불가능한 버전 스냅샷)

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/publish

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/publish \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

초안을 마지막으로 게시된 버전으로 재설정

매개변수

facilityId `string` (필수) workflowId `string` (필수)

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/discard

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/discard \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

Workflow 활성화 또는 비활성화

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

PATCH /api/workflow-engine/workflows/{facilityId}/{workflowId}/active

요청 예시

curl -X PATCH https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/active \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

AI로 Workflow 그래프 생성 또는 수정

매개변수

facilityId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/generate/{facilityId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/generate/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

이 시설에서 Agent 노드를 실행할 수 있는 모델 목록

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/agent-models/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/agent-models/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설에서 Agent 노드에 연결할 수 있는 MCP 도구 목록

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/agent-tools/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/agent-tools/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설에 저장된 Agent 대화 검색(Conversation key 바인딩)

매개변수

facilityId `string` (필수) deviceId `string` (선택) 하나의 Agent 기기 대화로 제한(노드에 구성된 deviceId) q `string` (선택) Conversation key, 세션 ID 또는 기기 이름에 대한 대소문자 구분 없는 부분 문자열 일치 limit `integer` (선택) offset `integer` (선택)

엔드포인트

GET /api/workflow-engine/agent-conversations/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/agent-conversations/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Agent 기기 자체에 보관된 대화 검색

기기 자체의 세션(Agent UI 사이드바 대화)을 나열하므로, Workflow에서 기존 대화를 해당 컨텍스트와 함께 이어 갈 수 있습니다. 기록은 기기가 소유합니다. 시설에 기기가 여러 대 있으면 `deviceId`로 대상 기기(노드에 구성된 기기)를 선택합니다. 기기에 연결할 수 없으면 502를 반환합니다.

매개변수

facilityId `string` (필수) deviceId `string` (선택) 노드에 구성된 Agent 기기이며, 생략하면 시설의 단일 기기로 확인됩니다 q `string` (선택) 세션 제목 또는 ID에 대한 대소문자 구분 없는 부분 문자열 일치 limit `integer` (선택) offset `integer` (선택)

엔드포인트

GET /api/workflow-engine/agent-device-sessions/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/agent-device-sessions/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Agent 기기 칸반에서 보드 검색

Agent: Kanban 블록의 Board ID 선택기에 데이터를 제공합니다. 보드 이름 또는 slug에 대해 대소문자를 구분하지 않고 부분 문자열로 일치시킵니다. `current`는 기기의 활성 보드 slug이므로 작업 선택기가 이를 기본 범위로 사용할 수 있습니다. 시설에 기기가 여러 대 있으면 `deviceId`로 대상 기기를 선택합니다. 기기에 연결할 수 없으면 502를 반환합니다.

매개변수

facilityId `string` (필수) deviceId `string` (선택) 노드에 구성된 Agent 기기이며, 생략하면 시설의 단일 기기로 확인됩니다 q `string` (선택) 보드 이름 또는 slug에 대한 대소문자 구분 없는 부분 문자열 일치 limit `integer` (선택) offset `integer` (선택)

엔드포인트

GET /api/workflow-engine/kanban-boards/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/kanban-boards/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

시설의 Agent 기기 칸반에서 한 보드의 작업 검색

Agent: Kanban 블록의 Task ID 선택기에 데이터를 제공합니다. 작업 ID, 제목 또는 본문에 대해 대소문자를 구분하지 않고 부분 문자열로 일치시킵니다. 작업은 보드별로 존재하므로(기기에는 보드 간 검색 기능이 없음) `board`로 조회 범위를 지정하며, 생략하면 기기의 활성 보드가 사용됩니다. 기기에 연결할 수 없으면 502를 반환합니다.

매개변수

facilityId `string` (필수) deviceId `string` (선택) 노드에 구성된 Agent 기기이며, 생략하면 시설의 단일 기기로 확인됩니다 board `string` (선택) 나열할 보드 slug이며, 생략하면 기기의 활성 보드가 사용됩니다 q `string` (선택) 작업 ID, 제목 또는 본문에 대한 대소문자 구분 없는 부분 문자열 일치 limit `integer` (선택) offset `integer` (선택)

엔드포인트

GET /api/workflow-engine/kanban-tasks/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/kanban-tasks/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

이 시설에 맞게 필터링된 엄선된 Workflow 템플릿 목록

매개변수

facilityId `string` (필수)

엔드포인트

GET /api/workflow-engine/templates/{facilityId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/templates/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

열려 있는 초안에 사용할 그래프 조각으로 템플릿 인스턴스화

매개변수

facilityId `string` (필수) templateId `string` (필수)

엔드포인트

POST /api/workflow-engine/templates/{facilityId}/{templateId}

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/templates/{facilityId}/{templateId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

템플릿 관리 페이지의 범위 선택기 컨텍스트(관리자 등급)

엔드포인트

GET /api/workflow-engine/template-admin/context

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/template-admin/context \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

호출자가 관리할 수 있는 템플릿 목록(권한 플래그 포함)

엔드포인트

GET /api/workflow-engine/template-admin

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/template-admin \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

템플릿 만들기(관리자 등급)

요청 본문

엔드포인트

POST /api/workflow-engine/template-admin

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/template-admin \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

관리 편집기용 템플릿 세부 정보(그래프 포함)

엔드포인트

GET /api/workflow-engine/template-admin/{templateId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/template-admin/{templateId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

템플릿 교체(소유 조직)

엔드포인트

PUT /api/workflow-engine/template-admin/{templateId}

요청 예시

curl -X PUT https://portal.hub.gymsystems.co/api/workflow-engine/template-admin/{templateId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

템플릿 소프트 삭제(소유 조직)

엔드포인트

DELETE /api/workflow-engine/template-admin/{templateId}

요청 예시

curl -X DELETE https://portal.hub.gymsystems.co/api/workflow-engine/template-admin/{templateId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

표시되는 템플릿을 호출자가 사용할 수 있는 대상 범위로 복제

요청 본문

엔드포인트

POST /api/workflow-engine/template-admin/{templateId}/duplicate

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/template-admin/{templateId}/duplicate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

수동 트리거로 Workflow의 게시된 그래프 실행

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/run

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/run \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

게시하지 않고 저장된 초안 테스트

현재 초안 그래프를 실행하고 결과를 `mode: test`로, `versionId` 없이 기록합니다. 게시, 라이브 플래그 및 `publishedVersionId`는 변경되지 않습니다. 부수 효과는 기본적으로 시뮬레이션되며, `sideEffects: live`를 사용하려면 추가로 `confirmLiveSideEffects: true`가 필요합니다.

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/test

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/test \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

허용 목록에 있는 Workflow 노드 하나 테스트

저장된 초안에서 독립적으로 테스트할 수 있는 노드 하나를 실행합니다. 변수 값은 기록된 실행 단계에서 가져올 수 있습니다. 데이터를 변경하는 HTTP 메서드는 명시적인 확인이 필요합니다.

매개변수

facilityId `string` (필수) workflowId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/test-node

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/test-node \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

Workflow의 최근 실행 목록

매개변수

facilityId `string` (필수) workflowId `string` (필수)

엔드포인트

GET /api/workflow-engine/workflows/{facilityId}/{workflowId}/runs

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/runs \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

실행 하나 읽기(상태 + 순서대로 정렬된 단계)

매개변수

facilityId `string` (필수) workflowId `string` (필수) executionId `string` (필수)

엔드포인트

GET /api/workflow-engine/workflows/{facilityId}/{workflowId}/runs/{executionId}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/runs/{executionId} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

대기 중인 실행이 머물러 있는 보류 중인 Delay 취소

매개변수

facilityId `string` (필수) workflowId `string` (필수) executionId `string` (필수)

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/runs/{executionId}/cancel

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/runs/{executionId}/cancel \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

완료된 실행을 기록된 트리거 페이로드로 다시 실행

`mode: published`는 원래 실행이 고정된 정확한 버전을 실제 부수 효과와 함께 다시 실행합니다. `mode: draft-test`는 현재 초안을 시뮬레이션 테스트로 다시 실행합니다. 기록 시 트리거 페이로드가 잘린 실행은 다시 실행할 수 없습니다.

매개변수

facilityId `string` (필수) workflowId `string` (필수) executionId `string` (필수)

요청 본문

엔드포인트

POST /api/workflow-engine/workflows/{facilityId}/{workflowId}/runs/{executionId}/retry

요청 예시

curl -X POST https://portal.hub.gymsystems.co/api/workflow-engine/workflows/{facilityId}/{workflowId}/runs/{executionId}/retry \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

응답

{}

노드 유형이 포함된 Workflow의 인덱스 조회

매개변수

nodeType `string` (필수) facilityId `string` (선택) organisationId `string` (선택)

엔드포인트

GET /api/workflow-engine/master-view/{nodeType}

요청 예시

curl -X GET https://portal.hub.gymsystems.co/api/workflow-engine/master-view/{nodeType} \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

화이트 라벨 OAuth 리디렉션 프록시(Connected Apps)

OAuth 공급자 콜백을 쿼리 문자열을 유지한 채 업스트림 도구 플랫폼의 인증 콜백으로 전달하는, 인증되지 않은 공개 302입니다. PH 소유 OAuth 앱이 performancehub.co 리디렉션 URI를 등록할 수 있으므로 업스트림 공급업체의 도메인이 주소 표시줄에 나타나지 않습니다(향후 사용자 지정 OAuth 앱 프로젝트에 필요하며, 관리형 인증에서는 영향이 없습니다).

엔드포인트

GET /guest/connected-apps/oauth-callback

요청 예시

curl -X GET https://portal.hub.gymsystems.co/guest/connected-apps/oauth-callback \
  -H "x-api-key: YOUR_API_KEY"

연결 체인 완료 페이지(Connected Apps)

연결 체인이 실행된 OAuth 탭에 표시되는 간단한 "이 창을 닫아도 됩니다" 랜딩 페이지입니다. 동일 출처 window.opener.postMessage를 통해 결과(연결된 제품군/툴킷 + 새 계정 ID 또는 실패한 툴킷)를 마켓플레이스 탭으로 다시 보냅니다. opener 연결이 끊어진 경우에는 앱 내 랜딩을 재현하는 ph-ai-agent 애플릿 딥 링크로 대체합니다. 정보 제공용일 뿐이며, 시크릿을 보관하거나 쓰기 작업을 수행하지 않습니다.

매개변수

connected `string` (선택) 연결을 완료한 제품군 ID 또는 툴킷 slug(성공한 경우)입니다. accounts `string` (선택) 체인이 생성한 연결 계정 ID(쉼표로 구분)입니다. connectError `string` (선택) 단계가 실패한 툴킷 slug(실패한 경우)입니다.

엔드포인트

GET /guest/connected-apps/finish

요청 예시

curl -X GET https://portal.hub.gymsystems.co/guest/connected-apps/finish \
  -H "x-api-key: YOUR_API_KEY"

응답

{}

제품군 연결 체인 콜백(Connected Apps)

원클릭 제품군 연결 흐름의 OAuth 콜백 단계입니다. 서명된 state JWT(HS256, TTL 30분)는 { clubID, deviceId, suite, toolkits, step, caids }를 인코딩합니다. 계정은 해당 에이전트 기기 하나에 연결되며, caids에는 각 단계에서 생성한 계정 ID가 누적됩니다(최종 애플릿 리디렉션에 이 값이 포함되므로 마켓플레이스에서 새 계정에 레이블을 지정하도록 제안할 수 있습니다). 해당 단계의 툴킷을 연결됨으로 표시한 다음, 다음 툴킷의 Connect Link로 302 리디렉션하거나, 제품군 연결이 완료되면 ph-ai-agent 애플릿 페이지(에이전트로 딥 링크됨)로 리디렉션합니다. 단일 툴킷 연결도 툴킷 하나로 구성된 제품군으로 같은 핸들러를 거칩니다.

매개변수

state `string` (필수) 서명된 연결 체인 state JWT입니다.

엔드포인트

GET /guest/connected-apps/connect-next

요청 예시

curl -X GET https://portal.hub.gymsystems.co/guest/connected-apps/connect-next \
  -H "x-api-key: YOUR_API_KEY"

비밀번호 설정 이메일 트리거

환영 이메일의 서명된 링크를 검증하고, 비밀번호 재설정 이메일을 트리거한 다음 확인 페이지를 표시합니다. 인증이 필요하지 않습니다.

매개변수

email `string` (필수) 사용자 이메일 주소 sig `string` (필수) 이메일의 HMAC 서명

엔드포인트

GET /guest/setup-password

요청 예시

curl -X GET https://portal.hub.gymsystems.co/guest/setup-password \
  -H "x-api-key: YOUR_API_KEY"

응답

{}