📄 API 문서 정리

저희 licota 팀의 notion의 API 문서를 모듈별로 정리하여 GitHub Wiki에 업로드하기 위해 각 모듈별로 주요 엔드포인트를 테이블 형식으로 정리하였습니다.

• 자세한 내용은 저희 팀의 Notion API 문서 을 참고해주세요.

---

Auth 모듈 🔑

경로 (Path)	메서드 (Method)	설명 (Description)
/auth/{provider}/callback	GET	{provider}로부터 인증 후 돌아오는 콜백 엔드포인트
/auth/logout	GET	로그아웃 처리 및 Refresh Token 제거
/auth/refresh	POST	토큰 갱신 및 새로운 Access Token 발급
auth/lico/guest	GET	가계정으로 로그인 및 회원가입

주요 기능 설명

• OAuth 인증: 다양한 OAuth 제공자 (naver, github, google)를 통한 사용자 인증을 지원합니다.
• 로그아웃 및 토큰 갱신: 사용자의 세션 관리를 위해 로그아웃 및 토큰 갱신 기능을 제공합니다.
• 가계정 로그인&회원가입 : 서비스 이용과 평가의 용이를 위해 가계정 기능을 추가했습니다.

---

Users 모듈 👤

경로 (Path)	메서드 (Method)	설명 (Description)
/users/{userId}	GET	특정 사용자의 프로필 조회
/users/{userId}	PUT	사용자 정보 업데이트

주요 기능 설명

• 사용자 프로필 조회 및 수정: 사용자 프로필 정보 조회 및 닉네임, 프로필 이미지 등의 정보를 업데이트할 수 있습니다.

---

Categories 모듈 📂

경로 (Path)	메서드 (Method)	설명 (Description)
/categories	GET	카테고리 목록 조회
/categories/{categoriesId}	GET	특정 카테고리 상세 정보 조회
/categories/{categoriesId}/lives	GET	특정 카테고리의 방송 목록 조회

주요 기능 설명

• 카테고리 관리: 서비스 내에서 제공되는 7가지 고정 카테고리의 목록 및 상세 정보를 제공합니다.
• 카테고리별 방송 조회: 특정 카테고리에 속한 라이브 방송 목록을 조회할 수 있습니다.

---

Live 모듈 🎥

경로 (Path)	메서드 (Method)	설명 (Description)
/lives	GET	실시간 진행 중인 스트리밍 목록 조회
/lives/{channelId}	GET	특정 라이브 방송의 상세 정보 조회
/lives/{channelId}	PATCH	방송 정보 수정
/lives/streaming-key	GET	스트리밍 키 조회 (JWT 인증 필요)
/lives/channel-id/{streamingKey}	GET	채널 ID 획득 (인코딩 서버에서 사용)
/lives/onair/{streamingKey}	POST	방송 시작 및 시작 시간 갱신
/lives/onair/{streamingKey}	DELETE	방송 종료
/lives/status/{channelId}	GET	채널 정보 조회
/lives/onair/{streamingKey}	GET	방송 시작 상태 정보

주요 기능 설명

• 라이브 방송 관리: 라이브 방송의 시작, 종료, 정보 조회 및 수정 기능을 제공합니다.
• 스트리밍 키 및 채널 ID 관리: 스트리밍에 필요한 키와 채널 정보를 관리합니다.
• 실시간 방송 목록 조회: 현재 진행 중인 라이브 방송들의 목록을 페이징 및 정렬 옵션과 함께 제공합니다.

---

Follow 모듈 🤝

경로 (Path)	메서드 (Method)	설명 (Description)
/follow	GET	사용자가 팔로우한 스트리머 목록 조회
/follow/{streamerId}	POST	스트리머 팔로우
/follow/{streamerId}	DELETE	스트리머 언팔로우
/follow/count/{streamerId}	GET	스트리머의 구독자 수 조회

주요 기능 설명

• 팔로우 관리: 사용자가 스트리머를 팔로우하거나 언팔로우할 수 있습니다.
• 팔로우 목록 및 카운트: 사용자가 팔로우한 스트리머 목록과 스트리머의 구독자 수를 조회할 수 있습니다.

---

도메인 정보 🌐

도메인	설명 (Description)
lico.digital	프론트엔드 페이지
api.lico.digital	프로덕션 API 서버 도메인
devapi.lico.digital	개발용 API 서버 도메인
relay.lico.digital	RTMP 및 WebRTC 수신 서버
chats.lico.digital	채팅 서버 웹소켓 연결 주소
rtc.lico.digital/rtc/v1/publish/	WebRTC 시그널링 주소
https://kr.object.ncloudstorage.com	Ncloud Object Storage (썸네일 및 스트리밍 매니페스트)

주요 기능 설명

• 도메인 및 서버 정보: 서비스에서 사용하는 주요 도메인과 서버의 정보를 제공합니다.
• 스트리밍 관련 URL: 라이브 스트리밍에 필요한 RTMP, WebRTC, 매니페스트 등의 URL을 제공합니다.

---

Socket 통신 💬

메시지 전송 양식

• 브라우저 → 서버

{
  "channelId": "UUID",
  "message": "채팅 메시지"
}

• 서버 → 브라우저

{
  "userId": 2,
  "nickname": "Viewer456",
  "message": "안녕하세요, 멋진 스트림이에요!",
  "timestamp": "2023-10-01T12:34:56Z",
  "filteringResult": true
}

주요 기능 설명

• 채팅 기능: 실시간 라이브 방송 중 채팅을 통해 스트리머와 시청자 간의 소통이 가능합니다.
• 메시지 필터링: Clova Studio 를 활용해 비속어 등의 필터링 기능을 지원합니다.