📘 온라인몰 API 문서 포털

Android 부트캠프를 위한 통합 API 서버

제공되는 API 서비스

사용자용 API

상품 조회, 회원가입, 주문 등
일반 사용자 기능 API 문서입니다.

Swagger 문서 보기

오픈 마켓 판매자 API

상품 관리, 주문 관리, 통계 등 관리
판매자를 위한 API 문서입니다.

Swagger 문서 보기

관리자 API

상품 , 주문 , 스토어 등 관리
운영자를 위한 API 문서입니다.

Swagger 문서 보기

📮 로그인 요청 / 응답 예시

📤 요청 (Request)

POST /api/auth/login
 Content-Type: application/json 
 X-Company-Code: eyJhbGciOiJIUzI1NiI
  {
    "email": "abc@aos.com",
    "password": "1234abcd"    
  }
      

📥 응답 (Response)

{
  "success": true,
  "message": "Login successful",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.",
    "user" : {
      "id": "507f1f77bcf86cd799439013",
      "email": "abc@aos.com",
      "name": "홍길동"
    }
  }
}

      

📮 상품 목록 요청 / 응답 예시

📤 요청 (Request)

POST /api/products
 Content-Type: application/json
 X-Company-Code: eyJhbGciOiJIUzI1NiI
  ```
  

📥 응답 (Response)

{
  "success": true,
  "message":"상품 목록 조회 성공",
  "data": {
    "items": [{
      "id": "60f7b3b3b3f3b3b3b3f3b3b3",
      "name": "오렌지족 티셔츠 105",
      "price": 20000,
      // 기타 필드 생략
    }]
  },
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "total": 15,
    "limit": 20,
    "hasNext": false,
    "hasPrev": false
  }
}


      

❓ 테스트 계정 정보

    [공용 테스트 서버 계정 정보]
    
    - X-Company-Code: 685f69fc439922c09c21aef0
    - 테스트 관리자 : admin@git.hansul.kr / 비밀번호: qwer1234
    - 테스트 판매자 : seller@mtz.kr / 비밀번호: qwer1234
    - 테스트 사용자 : buyer@mtz.kr / 비밀번호: qwer1234

    

    **사용법:**
    1. X-Company-Code 헤더에 회사 코드 설정
    2. 로그인 API를 통해 JWT 토큰 획득
    3. Authorization 헤더에 Bearer 토큰 설정
    4. API 호출
  

❓ 자주 묻는 질문 (FAQ)

Q. 로그인 토큰은 어디에서 발급되나요?
A. 사용자 로그인 API 응답에서 accessToken, refreshToken을 확인할 수 있습니다.

Q. 관리자 API는 어떤 인증이 필요한가요?
A. 헤더에 X-Company-Code와 JWT 토큰을 포함해야 합니다.

Q. 상품 등록 시 필수값은 뭔가요?

A. 아래와 같은 JSON 구조로 필드를 보내야 합니다:

* 상품 등록 요청 예시 (필수값은 name, price)
POST /api/products
Content-Type: application/json
Authorization: Bearer <access_token>
X-Company-Code: DEMO_SHOP 
  {
    "name": "상품 이름",
    "description": "상품 설명" ,
    "price": 10000,
    "images": "https://example.com/image.jpg" ,예2:{"thumbnail":"https://example.com/image.jpg", "detail":"https://example.com/detail.jpg"},      
    "category": "카테고리",
    "attributes": {
      "color": "red",
      "size": "M",
      "brand": "string",
      "material": "cotton",
      "warranty": "1 year",
      "stock": 100
    },
    "options": [
      {
        "name": "string",
        "values": ["string1", "string2"]      
      }
    ],
    discount: {
      "type": "percentage",
      "value": 10,
      "startDate": "2025-01-01T00:00:00Z",
      "endDate": "2025-12-31T23:59:59Z"
    }
  }
        

📬 개발자 문의

문의 이메일: dev.api@gmail.com