Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.vpms.io/llms.txt

Use this file to discover all available pages before exploring further.

​
개요

Core Service는 VPMS(Vendit Property Management System) 클러스터의 핵심 서비스로, 숙박 시설 관리를 위한 주요 비즈니스 로직을 제공합니다.

​
주요 기능

​
예약 관리

  • 예약 생성, 수정, 취소
  • 객실 배정 및 관리
  • 체크인/체크아웃 처리

​
인증 및 보안

  • SMS 기반 인증
  • 세션 관리
  • 접근 제어

​
요금 및 재고 관리 (ARI)

  • 객실 요금 설정
  • 재고 관리
  • 패키지 및 서비스 관리

​
결제 및 정산

  • Folio 관리
  • 청구서 생성
  • 마일리지 시스템

​
API 도메인

인증 (Auth)

SMS 기반 인증 시스템

예약 (Reservation)

예약 생성 및 관리

객실 (Room)

객실 및 객실 타입 관리

재고 (Inventory)

객실 재고 관리

요금 (ARI Rate)

객실 요금 설정

마일리지 (Mileage)

마일리지 적립 및 사용

​
기술 스택

  • API 타입: GraphQL (Apollo Federation)
  • 프레임워크: Fastify + TypeScript
  • 데이터베이스: PostgreSQL + Prisma ORM
  • 인증: JWT 기반
  • 이벤트: Event Sourcing

​
GraphQL Endpoint

POST https://development.vpms.io/graphql
GraphQL 공통 설정 및 인증 방법은 GraphQL 설정 가이드를 참고하세요.

​
시작하기

Core Service API를 사용하려면 먼저 인증 토큰이 필요합니다.
1

SMS 인증 요청

requestMileageSMSAuth를 호출하여 인증번호 발송
2

인증 확인

confirmMileageSMSAuth로 인증 토큰 획득
3

API 호출

발급받은 토큰으로 다른 API 엔드포인트 호출

​
예제 코드

import { ApolloClient, InMemoryCache, gql } from '@apollo/client';

const client = new ApolloClient({
  uri: 'https://development.vpms.io/graphql',
  cache: new InMemoryCache(),
  headers: {
    authorization: `Bearer ${YOUR_TOKEN}`,
  },
});

const GET_RESERVATIONS = gql`
  query GetReservations($accommodationId: ID!) {
    getReservations(accommodationId: $accommodationId) {
      id
      status
      guestName
    }
  }
`;

const { data } = await client.query({
  query: GET_RESERVATIONS,
  variables: { accommodationId: '01HQKS9V8X' },
});

​
관련 서비스

​
지원

문의사항이 있으시면 support@vendit.io로 연락주세요.