등록 및 관리

플레이어의 닉네임을 설정하거나 변경하는 API입니다.

URL 확인

이 API는 service-account.playnanoo.com 도메인을 사용합니다.

API 정보

• URL: https://service-account.playnanoo.com/api/v20240401/nickname/put
• Method: PUT
• 인증 필요: 예

요청 파라미터

파라미터	타입	필수	설명
change_nickname	string	필수	설정할 닉네임
check_exists	string	필수	중복 확인 여부 ("Y": 확인함, "N": 확인안함)
platform	string	필수	플랫폼 (예: "aos", "ios")
device_id	string	필수	기기 고유 ID
device_model	string	필수	기기 모델명
device_os	string	필수	기기 OS
device_language	string	필수	기기 언어 (예: "KO", "EN")

DeviceInfo 상속

이 API의 Req 클래스는 DeviceInfo를 상속받습니다. DeviceInfo의 모든 속성이 자동으로 포함됩니다.

응답 데이터

Res 클래스

필드	타입	설명
Nickname	string	설정된 닉네임

Unity C# 구현

BaseResponse 클래스

모든 API 응답의 기본 클래스입니다.

public class BaseResponse
{
    public string ErrorCode;
    public string Message;
    public string WithdrawalKey;
    public string BlockKey;
}

필드 설명:

• ErrorCode: 에러 코드
• Message: 에러 메시지
• WithdrawalKey: 탈퇴 유예 상태인 경우 복구에 필요한 키 (탈퇴 유예 중인 계정만 제공)
• BlockKey: 차단된 계정인 경우 제공되는 키 (차단된 계정만 제공)

닉네임 설정 클래스

using System;
using System.Collections;
using UnityEngine.Networking;

public class NicknamePut
{
    static string path = "https://service-account.playnanoo.com/api/v20240401/nickname/put";

    [Serializable]
    public class Req : DeviceInfo
    {
        public string change_nickname;
        public string check_exists;

        public IEnumerator Send(
            string change_nickname,
            bool check_exists,
            Action<Res> onSuccess,
            Action<BaseResponse> onError)
        {
            if (!string.IsNullOrEmpty(change_nickname)) this.change_nickname = change_nickname;
            this.check_exists = check_exists ? "Y" : "N";

            yield return HttpClient.Send<Req, Res>(
                UnityWebRequest.kHttpVerbPUT,
                path,
                requireToken: true,
                body: this,
                onSuccess: onSuccess,
                onError: onError
            );
        }
    }

    [Serializable]
    public class Res : BaseResponse
    {
        public string Nickname;
    }
}

사용 예제

public void SetNickname(string newNickname)
{
    NicknamePut.Req req = new NicknamePut.Req();

    StartCoroutine(req.Send(
        change_nickname: newNickname,
        check_exists: true, // 중복 확인 수행
        onSuccess: res =>
        {
            Debug.Log($"닉네임 설정 완료: {res.Nickname}");
        },
        onError: (error) =>
        {
            Debug.LogError($"닉네임 설정 실패: [{error.ErrorCode}] [{error.Message}]");

            if (error.ErrorCode == "NICKNAME_ALREADY_EXISTS")
            {
                Debug.LogError("이미 사용 중인 닉네임입니다.");
            }
        }
    ));
}

check_exists 파라미터

• true (또는 "Y"): 닉네임 중복 확인을 수행합니다. 중복된 닉네임이면 에러를 반환합니다.
• false (또는 "N"): 중복 확인을 건너뛰고 바로 설정합니다.

일반적으로 true로 설정하여 중복을 방지하는 것을 권장합니다.