콘텐츠로 이동

Guide Changes Notice

[개발자 가이드] 개발자 가이드 내용 및 구조 변경

개발자 가이드 내용과 구조를 아래와 같이 변경합니다.

변경 전

Hive SDK 초기화 가이드 페이지에서 프로비저닝, 고객센터, 커뮤니티 관련 개발 가이드를 함께 안내했습니다.

변경 후

Hive SDK 초기화, 프로비저닝, 고객센터, 커뮤니티 개발자 가이드 페이지를 분리합니다. 내용을 현행화하고 가독성과 접근성을 개선합니다.

API 문서 업데이트: Chat API 가이드 업데이트

API 분류를 변경했고 여러 필드 정보를 수정했습니다.

HTTP API 업데이트

  • 메시지 API 분류 추가
    • API 분류 변경
      • 기존: 채널 API > 공지 메시지 전송 API
      • 변경: 메시지 API > 채널 공지 메시지 전송 API
    • 사용자 공지 메시지 API 추가
    • 채널 커스텀 메시지 API 추가
    • 사용자 커스텀 메시지 API 추가
    • 채널 메시지 내역 조회 API 추가
  • 세부 에러 코드 추가
    • HTTP 상태 코드 400에 신규 코드 추가
      • 400 Custom message size exceeded. The maximum size is 8,000 bytes.: 커스텀 메시지 크기 초과 (최대 8,000바이트)
  • 응답 값에 extraData 제거
    • 채널 조회 API (response > data > members)
    • 채널 참여자 조회 API (response > data > members)
  • chatHistoryAllowed 메시지 이력 조회 가능 여부 추가
    • 전체 채널 목록 조회의 응답값
    • 채널 조회의 응답값
    • 채널 생성의 요청값
    • 사용자 참여 채널 조회의 응답값
  • 오타 수정 및 설명 변경
    • 전체 채널 목록 조회
      • Query parameters size 필드 설명 변경
        • 기존: 최소 10개 ~ 최대 100개
        • 변경: 최소 1개 ~ 최대 10개
    • timestampMillis 시간 타입 변경
      • integer → long
    • 채널 입장
      • 요청 예제 변경
    • 채널 메시지 내역 조회
      • API 엔드포인트 변경
      • Path 파라미터에서 Content-Type 제거
    • 채널 생성
      • 요청 데이터에 playerId 유무에 따른 동작 안내를 변경
    • 채널 퇴장
      • 채널 소유자가 SYSTEM이 아니면서 참여자가 없는 채널은 주기적으로 삭제된다는 설명 추가
    • 사용자 차단
      • 실시간 메시지 전송 및 수신을 제한하기 위한 기능이라는 설명 추가
    • 채널 공지 메시지
      • 요청 데이터에 channelId, langCode 유무에 따른 동작 안내를 추가
    • 개요 설명 수정
    • 문구 변경
      • 시간 → 일자
    • 일부 띄어쓰기 수정
    • 타입 중 array 의 표기 변경
      • 예시: array → object array

WebSocket API 변경 사항

  • 패킷 유형
    • NOTIFY_NOTICE 추가
  • 클라이언트 접속
    • 요청 예제 변경
  • 클라이언트 재연결
    • 요청 예제 변경
  • 공지 메시지
    • 사용자 공지 메시지로 명칭 변경
    • Body playerId 정보 변경
  • 채널 공지 메시지
    • Body channelId 정보 변경
  • extraData 데이터 전송 패킷 변경
    • 요청 값에 extraData 제거
      • CONNECT
      • RECONNECT
    • 요청 값에 extraData 추가
      • CHANNEL_CHAT
      • DIRECT_CHAT
    • 응답 값에 extraData 제거
      • NOTIFY_ENTER_CHANNEL
      • NOTIFY_EXIT_CHANNEL
    • 응답 키 값 변경 (fromExtra → extraData)
      • NOTIFY_CHANNEL_CHAT
      • NOTIFY_DIRECT_CHAT
  • 응답 값에 timestampMillis 추가
    • NOTIFY_ENTER_CHANNEL
    • NOTIFY_EXIT_CHANNEL
    • NOTIFY_DELETE_CHANNEL
    • NOTIFY_CHANNEL_NOTICE
    • NOTIFY_CHANNEL_CHAT
    • NOTIFY_DIRECT_CHAT
  • 요청 값에 langCode 추가
    • CONNECT
    • RECONNECT
  • Socket 서버 이벤트 메시지 추가
    • NOTIFY_NOTICE
  • deprecate 패킷 제거
    • NOTIFY_DISCONNECT

API 문서 업데이트: 응답 형식 및 필드 변경

API 응답 형식이 변경되었으며, 여러 필드가 추가되거나 삭제되었습니다.

API 문서 업데이트

  • API 응답 형식 변경
    • 현재 접속인원을 알 수 있는 memberCount 추가
    • regTimeMillis 필드 추가 (타입: integer)
  • 채널 조회 API
    • memberCount 필드 추가
    • regTimeMillis 필드 추가
  • 참여자 정보 조회 API
    • connectedTimeMillis 필드 추가
  • 사용자 참여 채널 조회 API
    • memberCount 필드 추가
  • 채널 OWNER 퇴장 시 채널 삭제를 채널 유지로 변경

WebSocket API 변경 사항

  • 새로운 재연결 기능 추가
    • RECONNECT 패킷 유형 추가
    • 이전 채널에 다시 참여할 수 있는 기능 포함
  • 소켓 연결 해제 프로세스 설명 수정
    • 연결 시 클라이언트의 요청이 없는 경우 처리 추가
    • 접속 중인 상태에서 다른 단말로 접속하는 경우, 기존 접속 종료
    • DISCONNECT 제거
  • 소켓 통신 구조 수정
    • correlationId 필드 추가
  • 응답 패킷 형식 및 서버 메시지 패킷 형식 수정
    • 새로운 패킷 필드 내용 추가 및 상세화
    • 요청 패킷, 응답 패킷, 서버메시지 패킷으로 구분