사전 준비하기

NEXON Open API에서 API를 사용하기 위해서는 ① 넥슨 ID로 로그인한 후, ② 애플리케이션 등록을 통해 API Key 발급 받아야 합니다. API Key는 사용이 허가된 개발자인지 확인하는 인증 값이며, 애플리케이션등록 시 자동 발급됩니다. 향후 Open API를 호출할 때 http 헤더에 API Key를 포함해서 전송해야 하며, API 허용량은 애플리케이션별로 합산됩니다.

넥슨 ID로 로그인하기

NEXON Open API를 활용하려면 NEXON 계정으로 로그인해야 합니다.이미 넥슨 ID가 있는 넥슨 회원이시면 상단 우측에 있는 '로그인' 버튼을 눌러 로그인할 수 있으며, 아직 넥슨 ID가 없으시다면 회원가입을 통해 넥슨 ID를 발급받으실 수 있습니다.넥슨 ID를 통해 내 애플리케이션에서 나의 애플리케이션을 등록하고, 등록된 애플리케이션에 따른 권한(API Key)을 받을 수 있습니다.

애플리케이션 등록하기

1. 넥슨 ID로 로그인 후 내 애플리케이션 > 애플리케이션 등록 버튼을 클릭한 후, 애플리케이션 정보를 기재합니다.
   1. 게임 선택 : 서비스를 제공할 게임을 선택합니다.
   2. 애플리케이션 타입 선택 : 개발/서비스 단계가 있으며, 각 타입별 기재해야 하는 정보가 상이합니다.
      1. 개발 단계 : 서비스명
      2. 서비스 단계 : 서비스명, 개발 환경, URL 정보, 소개, 대표 이미지
   3. 이용 약관 동의 후 등록


2. 애플리케이션 등록이 정상적으로 완료되면 API Key가 자동으로 발급됩니다. (내 애플리케이션 > 애플리케이션 목록 > 애플리케이션 상세 페이지에서 확인 가능합니다.)
   1. API Key는 등록한 애플리케이션별 최대 2개 발급받을 수 있으며, 하나의 넥슨 ID에 동일 게임의 애플리케이션을 최대 3개까지 등록할 수 있습니다.
   2. 애플리케이션의 타입(개발 단계 / 서비스 단계)에 따라, 호출 정책과 유효성을 검사하는 기준이 달라집니다.
   3. 애플리케이션 개발이 종료되고, 서비스 단계로 변경될 경우 신규 발급을 통해 API Key를 새로 발급받아야 합니다.

애플리케이션 타입

NEXON Open API에서는 개발 단계와 서비스 단계 두 가지 타입의 애플리케이션 타입을 제공합니다. 개발 단계는 제한된 호출 허용량으로 구성되어 API를 테스트해 보거나 애플리케이션을 개발하는 동안 사용하기에 적합합니다. 서비스 단계는 더욱 높은 호출 허용량으로 구성되어 애플리케이션을 출시하여 많은 사용자가 사용할 수 있도록 설정하는 단계에 적합합니다.

애플리케이션 신규 등록 시, 발급 희망 애플리케이션 타입을 서비스로 선택한 후, 유효한 서비스 URL과 애플리케이션 설명 및 API 활용 목적을 모두 기재하면 발급됩니다. 서비스 URL이 아직 없을 수 있는 개발 단계에서는 개발 애플리케이션 타입을 사용한 후, 서비스 URL이 준비된 시점에 서비스 애플리케이션 타입으로 새로 등록하여 사용하는 것을 추천합니다.

API Key 추가 발급

API Key 외부 유출 등의 사유로 API Key 추가 발급이 필요할 수 있습니다. 내 애플리케이션 > 애플리케이션 상세 페이지에서 API Key를 추가 발급받을 수 있습니다. 이후 서비스에 적용된 API Key를 추가 Key로 변경해서 사용해 주세요.