캐릭터 조회 V1.0 API

STOVE 내 서비스에 게임 캐릭터를 조회합니다.

Resource URL

Resource URI	- Live : https://api.onstove.com/game/v1.0/character - SandBox : https://api.gate8.com/game/v1.0/character
HTTP Method	GET
Content-Type	application/x-www-form-urlencoded

Request Document

Request Header

Header	Format	Description
Authorization	Bearer {Access Token}	플랫폼의 API를 사용하기 위한 세션값 또는 Token

Request Parameter

KEY	Data Type	Required	example	Description
game_no	Long	Y	223	게임 번호

Request Example

curl --location --request GET 'https://api.gate8.com/game/v1.0/character?game_no=223' \
--header 'Authorization: bearer eyJhbGciOiJIUzI1NiJ9.eyJleHBpcmVfdGltZSI6MTYwNDMwMjU4MjkxMiwibWVtYmVyX25vIjozNDUwMDIsImFwcGxpY2F0aW9uX25vIjoxMDAwMn0.ejZDcjzcMYzEZhEOH6T5I6dqtJ7EOxzFdUVDnYWG-e8sFa1x0jipYKqqS9x6dINDZBW0iMsX3f-MTnUpxBUs0j4PuasED_xBTrfi7O3OLvbinqgF49HB7Xq8K5ZDDWubLzB-C1jMIV29FZbSwWvgSw4a7i5gPE3lJgU8Q4YMRySnoCLnwuvyyEFmC_IrzWVHdqPt6oGhUNsM8lOC69v_8Q' \
--header 'Content-Type: application/x-www-form-urlencoded'

Response Document

Response Data

Key	Data Type	Example	Description
result	String	000	리턴 코드 (000 : 성공)
message	String		리턴 메시지
value	Properties		응답 정보

Value properties

Property	Application 자료형	Description
id	String	캐릭터 아이디
game_no	long	게임 식별자 (Key, nullable)
member_no	long	기본 제공, 회원 식별자(Key)
nickname_flag	String (1)	닉네임 노출 여부 - P: 플랫폼 닉네임 노출 - G: 게임 닉네임 노출
region_no	Integer	mongoDB region 번호 (현재는 1만 존재)
reg_dt	java.util.Date	가입일 (1970년 1월 1일부터 millisecond)
upd_dt	java.util.Date	가입일 (1970년 1월 1일부터 millisecond)
character_infos	-	아래 참고
main_game_character	-	아래 참고

Character_infos, Main_game_character properties

Property	Application 자료형	Description
character_id	String (150)	캐릭터 아이디 (게임에서 생성하여 전달함)
world_id	String (30)	월드 아이디 (서버 id (default = 0)
character_seq	Integer	캐릭터 seq 번호 (characterInfos의 순서)
name	String (100)	캐릭터명
character_info	String (200)	게임사별 캐릭터 정의 정보 (json형식으로 자유롭게 등록) ex) 소울워커 : {""""level"""":70,""""hair"""":1502,""""hair_color"""":2502,""""eye_color"""":5502,""""skin_color"""":3501} ex) 테일즈런너:  {""""exp"""":""""88959646"""",""""Likeability"""":""""970"""",""""rank"""":""""128365"""",""""ladderPoint"""":""""10045"""",""""gameMoney"""":""""339041""""}
profile_image_url	String (300)	프로필 이미지 경로
is_main_character	String (1)	메인 캐릭터 여부(Y/N)
level	String (20)	레벨
reg_dt	Long	생성일시 (1970년 1월 1일부터 millisecond)- Timestamp
upd_dt	Long	변경일시 (1970년 1월 1일부터 millisecond)- Timestamp
exp	Long	경험치

Response Example

{
    "value": {
        "id": "5d89c11df132042c7643782e",
        "game_no": 223,
        "member_no": 345002,
        "character_infos": [
            {
                "character_id": "02232f4ce4bf7129441bc7c461ca14b90a450d57f5b7b47898bbfb25c873d32599fd3956866aac6a12b63618fbc75322c3daf01b85b600090441209f8a586417",
                "world_id": "1",
                "character_seq": 0,
                "name": "STOChnm001",
                "character_info": "{\"level\":1,\"hair\":1701,\"hair_color\":2701,\"eye_color\":5701,\"skin_color\":3701}",
                "profile_image_url": null,
                "is_main_character": "Y",
                "level": "1",
                "reg_dt": 1604281430144,
                "upd_dt": 1604281430144,
                "exp": 0
            },
            {
                "character_id": "3655a478cf8976382a69266cb093a0c931d4a2334aef6bbf088b3d2624dce9d8f6a759443d1a521d1d13492231145f2c6d779398392b55855763dc2063117927",
                "world_id": "1",
                "character_seq": 1,
                "name": "STOChnm002",
                "character_info": "{\"level\":1,\"hair\":1701,\"hair_color\":2701,\"eye_color\":5701,\"skin_color\":3701}",
                "profile_image_url": null,
                "is_main_character": null,
                "level": "1",
                "reg_dt": 1604281544605,
                "upd_dt": 1604281544605,
                "exp": 0
            },
            {
                "character_id": "7129441bc7c46",
                "world_id": "1",
                "character_seq": 2,
                "name": "STOChnm003",
                "character_info": "{\"level\":2,\"hair\":1701,\"hair_color\":2701,\"eye_color\":5701,\"skin_color\":3701}",
                "profile_image_url": null,
                "is_main_character": null,
                "level": "2",
                "reg_dt": 1604281611391,
                "upd_dt": 1604286092845,
                "exp": 0
            }
        ],
        "nickname_flag": "P",
        "region_no": 1,
        "reg_dt": 1569308957671,
        "upd_dt": 1604286092845,
        "main_game_character": {
            "character_id": "02232f4ce4bf7129441bc7c461ca14b90a450d57f5b7b47898bbfb25c873d32599fd3956866aac6a12b63618fbc75322c3daf01b85b600090441209f8a586417",
            "world_id": "1",
            "character_seq": 0,
            "name": "STOChnm001",
            "character_info": "{\"level\":1,\"hair\":1701,\"hair_color\":2701,\"eye_color\":5701,\"skin_color\":3701}",
            "profile_image_url": null,
            "is_main_character": "Y",
            "level": "1",
            "reg_dt": 1604281430144,
            "upd_dt": 1604281430144,
            "exp": 0
        },
        "empty": false
    },
    "message": "OK",
    "result": "000"
}

Return Code

Return Code	Message	HTTP Status Code	Description
0	OK	200	성공
501	Data not found.	200	캐릭터가 존재하지 않을 경우(member_no, game_no, character_id 기준)
515	Invalid AccessToken.	200	AccessToken이 유효하지 않을 경우
701	Game not found.	200	존재하지 않은 게임일 경우(game_no 기준)
40100	no token	401	Access Token을 정의하지 않고 호출했을 경우
40101	invalid token	401	유효하지 않은 Access Token으로 호출했을 경우
40102	invalid token	401	유효하지 않은 Access Token으로 호출했을 경우
40103	expired token	401	만료된 Access Token으로 호출했을 경우
40104	expired token	401	만료된 Access Token으로 호출했을 경우