시작하기
Socket API 개요
SSAPI의 Socket API는 Socket.IO 프로토콜 4.7.4 버전을 기반으로 실시간 데이터를 제공합니다. Socket.IO는 다양한 언어와 플랫폼에서 낮은 지연시간과 확장성 있는 소켓 서비스를 구축할 수 있도록 해주는 인기 있는 프로토콜입니다.
주의사항
일반적인 표준 소켓 프로토콜과는 다르기 때문에 반드시 호환되는 Socket.IO 클라이언트를 사용해야 합니다. 클라이언트 버전을 선택할 때 서버 버전인 4.x와 호환되는지 꼭 확인하시기 바랍니다.
Socket API 특징
- Socket.IO 4.7.4 기반: 낮은 지연시간과 확장성 있는 소켓 서비스 제공
- 실시간 데이터 스트리밍: 채팅과 후원 데이터를 실시간으로 수신
- 데이터 압축 전송: Snappy 압축을 통한 효율적인 대역폭 사용
- 다양한 플랫폼 지원: 대부분의 프로그래밍 언어와 플랫폼에서 사용 가능 (공식 및 서드파티 클라이언트 제공)
사용 절차
- 소켓 접속: Socket.IO 클라이언트를 통한 서버 연결
- 인증: API 키를 이용한 로그인
- 데이터 수신: Event Listener를 통한 실시간 데이터 수신
서버 정보
소켓 서버 주소: https://socket.ssapi.kr
데이터 압축
중요 안내 사항
소켓의 응답 데이터는 네트워크 대역폭 절약을 위해 압축하여 제공됩니다.
- 응답 데이터는 Google의 Snappy 압축 알고리즘 사용
- 빠른 압축 해제 속도로 초당 최대 2,000개의 메시지 처리 가능
- 수신된 데이터는 압축 해제 후 JSON 형식으로 변환 필요
- 요청 데이터는 빈번하지 않아 압축하지 않아도 됨
- Snappy는 압축률보다 압축 해제 속도에 최적화되어 있음
Event 리스너
Event 리스너는 소켓으로 들어오는 다양한 종류의 데이터를 효율적으로 필터링하는 데 사용됩니다.
주요 이벤트
connect: 소켓 연결 성공 시 발생disconnect: 소켓 연결 해제 시 발생chat: 채팅 메시지 수신 시 발생donation: 후원 데이터 수신 시 발생
정보
현재 수집되는 이벤트의 종류는 더 많지만, 현재는 일부 이벤트만 지원되고 있습니다. 이벤트 리스너의 종류와 반환되는 데이터에 대한 자세한 내용은 사양문서를 참고해주세요.
자세한 구현 예제는 다음 페이지에서 확인하실 수 있습니다.