Shop api protocol - SG-Finder/auth_server GitHub Wiki

Deal Item

Request

  • endpoint: POST /finder/shop
  • header
Key Value Type Info
session-token askfziouh&%=as string μ„Έμ…˜ν† ν°
userId gksxodnd007 string 아이디
  • body
Key Value Type Info
nickname Zookeeper string ν”Œλ ˆμ΄μ–΄ λ‹‰λ„€μž„
item knife string μ•„μ΄ν…œ 이름
count 2 int μ•„μ΄ν…œ 이용ꢌ 횟수

count 값이 음수일 경우 판맀둜 인식

Response

Success

  • status code: 200
  • body
Key Value Type Info
nickname Zookeeper string ν”Œλ ˆμ΄μ–΄μ˜ λ‹‰λ„€μž„
weapons [ knife, gun ] json array μ•„μ΄ν…œ λͺ©λ‘
point 0 int ν”Œλ ˆμ΄μ–΄μ˜ 포인트

example

{
    "nickname": "zookeeper",
    "weapons": [
        {
            "name": "knife",
            "damage": 50,
            "price": 100,
            "usableCount": 3
        },
        {
            "name": "gun",
            "damage": 100,
            "price": 200,
            "usableCount": 3
        }
    ],
    "point": 100
}

Fail

Key Value Type Info
code 409 int μ—λŸ¬ μ½”λ“œ
message ν¬μΈνŠΈκ°€ λΆ€μ‘±ν•©λ‹ˆλ‹€ string μ—λŸ¬ λ©”μ‹œμ§€

Fail이 될 수 μžˆλŠ”κ²½μš°

404 : BAD_REQUEST

  • body의 parameter form규격이 λ§žμ§€ μ•Šμ„κ²½μš°

409 : UNAUTHORIZED

  • 토큰 값이 만료 됐을 경우
  • ν¬μΈνŠΈκ°€ λΆ€μ‘±ν•  경우

500 : INTERNAL SERVER ERROR

Get Shop's Item List

Request

  • endpoint: GET /finder/shop/item?count={count}&cursor={cursor}
  • header
Key Value Type Info
session-token askfziouh&%=as string μ„Έμ…˜ν† ν°

Response

Success

Key Value Type Info
cursor 10 int λ‹€μŒ νŽ˜μ΄μ§€ 토큰
totalCount 20 int item의 총 갯수
data [{item1}, {item2}] json Array item의 데이터듀

Fail

Key Value Type Info
code 400 int μƒνƒœ μ½”λ“œ
message λ‹‰λ„€μž„μ„ μž…λ ₯ν•΄μ£Όμ„Έμš” string μ—λŸ¬ λ©”μ‹œμ§€

Fail 이 될 수 μžˆλŠ” 경우

401 : UNAUTHORIZED

  • header에 토큰값이 μ—†κ±°λ‚˜ 만료 λ˜μ—ˆμ„ 경우

500 : INTERNAL SERVER ERROR