메인 콘텐츠로 건너뛰기

Documentation Index

Fetch the complete documentation index at: https://docs.hyperx.dev/llms.txt

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

Unity SDK 사용을 권장하지만, 서버 사이드 도구나 운영 자동화가 필요하면 HyperX Core 공개 REST API를 직접 호출할 수 있습니다.

​
문서 URL

  • ReDoc: https://core.hyperx.dev/reference
  • Swagger UI: https://core.hyperx.dev/swagger
  • OpenAPI JSON: https://core.hyperx.dev/openapi.json

​
공통 헤더

헤더필수설명
x-project-code예Console에서 확인한 프로젝트 코드입니다. SDK는 자동으로 전송합니다.
Authorization: Bearer <access_token>인증 API에서 예로그인 후 받은 access token입니다.
x-hyperx-sdk-version아니오공식 SDK가 전송하는 SDK 버전입니다.
x-hyperx-runtime아니오Unity, .NET 등 실행 환경입니다.
x-trace-id아니오로그 추적에 사용할 ID입니다.
x-request-id아니오요청 한 건을 구분하는 ID입니다.

​
주요 API 영역

영역대표 기능
프로젝트프로젝트 조회, 서버 시간
유저게스트/커스텀/소셜 로그인, 세션 갱신, 로그아웃, 현재 유저, 캐릭터
데이터공유 데이터, 유저 데이터, 유저 프리퍼런스, 캐릭터 데이터
콘텐츠Public Storage, 게임 설정, 확률표
LiveOps랭킹, 쿠폰, 게임 로그, 운영 콘텐츠, 푸시 디바이스
결제스토어 구매 검증, 구매 이력, 환불/취소 webhook
소셜검색, 랜덤 조회, 친구, 우편, 쪽지, 길드, 알림
실시간알림 스트림, 채팅 채널, 메시지, 읽음 위치, 신고

​
오류 형식

오류 응답은 JSON으로 반환되며, SDK에서는 같은 정보를 HyperXServerException으로 읽을 수 있습니다. 
{
  "error": "unauthorized",
  "code": "UNAUTHORIZED",
  "message": "unauthorized",
  "service": "core",
  "trace_id": "trace_123",
  "request_id": "request_123",
  "context": {}
}
게임 클라이언트의 오류 처리 방식은 에러 처리를 참고하세요.