getUserKeyForGame

Deprecated

getUserKeyForGame은 더 이상 사용되지 않습니다. 대신 getAnonymousKey를 사용하세요. 타입과 동작이 동일합니다.

게임 카테고리 미니앱에서 익명 키(anonymous key)를 발급합니다. 서버가 토스 계정과 직접 통신하지 않고도 게임 세션을 식별할 수 있도록 하는 단기 키입니다.

시그니처

import { getUserKeyForGame } from '@apps-in-toss/web-framework';

declare function getUserKeyForGame(): Promise<
  | { key: string }
  | 'INVALID_CATEGORY'
  | 'ERROR'
  | undefined
>;

파라미터

없음.

반환값

• Promise<{ key: string } | 'INVALID_CATEGORY' | 'ERROR' | undefined>
  • { key: string } — 발급 성공. key는 익명 세션 키입니다.
  • 'INVALID_CATEGORY' — 게임 카테고리 미니앱이 아닌 환경에서 호출했습니다.
  • 'ERROR' — 알 수 없는 오류가 발생했습니다.
  • undefined — 앱 버전이 최소 지원 버전보다 낮습니다.

권한

권한이 필요하지 않습니다. 토스 세션(계정 연결)이 처리합니다.

마이그레이션

getUserKeyForGame → getAnonymousKey로 교체:

// 이전 코드
import { getUserKeyForGame } from '@apps-in-toss/web-framework';
const result = await getUserKeyForGame();

// 권장 코드
import { getAnonymousKey } from '@apps-in-toss/web-framework';
const result = await getAnonymousKey();

예제

최소 예제

import { getUserKeyForGame } from '@apps-in-toss/web-framework';

const result = await getUserKeyForGame();

if (!result) {
  console.warn('앱 버전이 최소 지원 버전보다 낮습니다.');
} else if (result === 'INVALID_CATEGORY') {
  console.error('게임 카테고리 미니앱에서만 호출할 수 있습니다.');
} else if (result === 'ERROR') {
  console.error('익명 키 발급 중 오류가 발생했습니다.');
} else {
  console.log('익명 키:', result.key);
}

직접 실행해 보기

sdk-example의 Auth 페이지에서 getUserKeyForGame 카드를 실행해 결과를 확인할 수 있습니다.

→sdk-example에서 실행해 보기

관련 API

• getAnonymousKey — 권장 후속 API. 동일한 타입과 동작.
• appLogin — 토스 계정 기반 로그인 흐름.
• getGameCenterGameProfile — 게임센터 프로필을 조회합니다.

관련 가이드

• Guides — 익명 키를 활용한 게임 세션 식별 패턴

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.