Skip to main content

Important Notice

This guide covers important information you need to know when using the PlayNANOO REST API.

Example Code Notice

The example code included in this documentation is for reference purposes to help you understand PlayNANOO API integration. When applying to your actual project, please feel free to modify it according to your project's architecture and coding conventions.

Required Request Headers

The following headers must be included in all API calls.

HeaderDescriptionRequired
X-Playnanoo-KeyService Key issued from the consoleO
X-Playnanoo-IdGame ID issued from the consoleO
AuthorizationBearer {access_token} format (for authenticated APIs)
Content-Typeapplication/jsonO
Obtaining Credentials

Get your Game ID, Service Key, and Secret Key from Console > Channel > Settings > API & Platform Management.

Common Request Parameters

Most APIs require the device information below. To avoid entering these manually for each request, you can conveniently inherit from the DeviceInfo class provided in the basic configuration.

ParameterTypeDescription
uuidstringPlayer unique ID (issued after login)
nicknamestringPlayer nickname
device_idstringDevice unique ID
versionstringApp version
platformstringPlatform (aos, ios)
device_modelstringDevice model name
device_osstringDevice OS version
device_languagestringDevice language (KO, EN, etc.)
device_countrystringCountry code (KR, US, etc.)
device_timeoffsetstringUTC time offset (in seconds)

Authentication Token Management

Access Token

  • Issued upon successful login
  • Included in the Authorization header for API requests
  • Refresh with Refresh Token when expired

Refresh Token

  • Used to renew Access Token
  • Has longer validity than Access Token
  • Re-login required when expired
Token Refresh Flow
  1. API call → 401 Unauthorized response
  2. Call /token/refresh with Refresh Token
  3. New Access Token issued
  4. Retry original API call

Error Response Format

When an API call fails, the response is returned in the following format.

{
"ErrorCode": "에러 코드",
"Message": "에러 메시지"
}

Common HTTP Status Codes:

  • 400 - Bad Request (parameter error)
  • 401 - Authentication Failed (token expired/invalid)
  • 403 - Forbidden
  • 404 - Resource Not Found
  • 500 - Server Error

Important Notes

Secret Key Security

Never hardcode the Secret Key in client code. Use it only on the server side or manage it through environment variables.

Rate Limit

Excessive API calls may result in temporary blocking. Maintain appropriate call intervals.

Next Steps