Important Notice
This guide covers important information you need to know when using the PlayNANOO REST API.
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.
| Header | Description | Required |
|---|---|---|
X-Playnanoo-Key | Service Key issued from the console | O |
X-Playnanoo-Id | Game ID issued from the console | O |
Authorization | Bearer {access_token} format (for authenticated APIs) | △ |
Content-Type | application/json | O |
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.
| Parameter | Type | Description |
|---|---|---|
uuid | string | Player unique ID (issued after login) |
nickname | string | Player nickname |
device_id | string | Device unique ID |
version | string | App version |
platform | string | Platform (aos, ios) |
device_model | string | Device model name |
device_os | string | Device OS version |
device_language | string | Device language (KO, EN, etc.) |
device_country | string | Country code (KR, US, etc.) |
device_timeoffset | string | UTC time offset (in seconds) |
Authentication Token Management
Access Token
- Issued upon successful login
- Included in the
Authorizationheader 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
- API call → 401 Unauthorized response
- Call
/token/refreshwith Refresh Token - New Access Token issued
- 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- Forbidden404- Resource Not Found500- Server Error
Important Notes
Never hardcode the Secret Key in client code. Use it only on the server side or manage it through environment variables.
Excessive API calls may result in temporary blocking. Maintain appropriate call intervals.
Next Steps
- Unity Basic Setup - Unity project setup guide
- Unreal Basic Setup - Unreal project setup guide