Getting Started
To utilize the API in NEXON Open API, you must ① sign in with a NEXON ID, and then ② complete the application registration to receive an API key. The API key serves as an authentication token to verify if a developer is authorized and is automatically issued upon application registration. For future API calls, the API key must be included in the HTTP header of the request. Note that the API usage limit is calculated on a per-application basis.
Sign in with a NEXON ID
To use NEXON Open API, you must sign in with a NEXON account.If you are a NEXON member and already have a NEXON ID, you can sign in by clicking the “Sign In” button in the top right corner. If you do not have a NEXON ID yet, you can click Sign Up to receive one.With a NEXON ID, you can register your applications in My Applications and receive authorizations (API keys) according to your registered applications.
Register an application
- After signing in with your NEXON ID, go to My Applications > Register Application and enter the details of your application.
- Select a game: Select the game you want to provide a service for.
- Select an application type: There are two types, development phase and launch stage, and the information required for each type is different.
- Development phase: Service name
- Service stage: Service name, development environment, URL information, introduction, featured image
- Agree to the Terms and Conditions, and register the application.
- Once your application has been successfully registered, you will automatically be issued with an API key. (You can check API keys by going to My Applications > Application List > Application Details.)
- Up to two API keys can be issued for each registered application, and up to three applications can be registered for the same game with one NEXON ID.
- The access policy and validation criteria vary depending on the type of application (development phase/launch stage).
- When an application moves from development to the launch stage, you will need to reissue a new API key.
Application type
NEXON Open API offers two application types: development phase and service stage. The allowed number of requests is limited for development phase applications, making this type ideal for testing out the API or for use while developing an application. Request allowance is increased for launch stage applications, making this type ideal for releasing your application and making it available to many users.
Application type | Limit per second | Daily limit |
---|---|---|
Development phase | 5 requests / sec | 1,000 requests / day |
Launch stage | 500 requests / sec | 20,000,000 requests / day |
When registering a new application, select the application type you wish to be issued a key for as “service” and then enter a valid service URL, application description, and API usage purpose to be issued an API key. For applications in the development phase where the service URL may not exist yet, it is recommended to use the “development” application type and then register the application as a new “service” application type once the service URL is ready.
Requesting a new API key
An additional issuance of an API key may be necessary due to reasons such as external leakage of the current API key. You can request a new API key by going to My Applications > Application Details. Then, change the API key applied to the service to the new key before continuing to use it.