logo

OAuth 기본 정보
인증
리소스 API
Token 관리

사용자 가입 팬클럽 - 목록 조회

SMTOWN 회원이 가입한 팬클럽 목록을 제공합니다.
fanclub scope가 필요합니다.

변경사항
  • 버전 endpoint 제공 : v1/me/fanclubs , 기존 me/fanclubs 도 사용 가능 (2022-07-13)
GET https://openapi.smtown.com/api/v1/me/fanclubs?page=1&size=10
Authorization: Bearer 2a324609ec94f18d614d4bc425de754
파라메타 필수여부 설명
Authorization Header 필수 인증 섹션에서 받은 Bearer token 입니다.
page 옵션-QueryString 요청 page 번호, 기본값 1
size 옵션-QueryString 페이지당 아이템 갯수, 기본값 10, 최대 50 (50보다 클 경우 50으로 자동 조정됩니다)
성공 응답
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
    "page": 1,
    "size": 10,
    "totalItems": 8,
    "items": [
        {
            "code": "boa",
            "name": "Jumping BoA",
            "grade": 1,
            "year": 1,
            "periodFrom": "2022-06-28T07:50:53.000Z",
            "periodTo": "2022-06-28T07:50:53.000Z",
            "issuedAt": "2022-06-28T07:50:53.000Z",
            "updatedAt": "2022-06-28T07:50:53.000Z"
        },
        {
            "code": "fanclub-code",
            "name": "fanclub-name",
            "grade": 1,
            "year": 1,
            "periodFrom": "2022-06-28T07:50:53.000Z",
            "periodTo": "2022-06-28T07:50:53.000Z",
            "issuedAt": "2022-06-28T07:50:53.000Z",
            "updatedAt": "2022-06-28T07:50:53.000Z"
        },
        ...
    ]
}
파라메타 타입 설명
page Integer 현재 페이지 번호
size Integer 페이지당 item 수
totalItems Integer item의 전체 갯수
items Object item 목록
ㄴ code String 팬클럽 고유 코드 (영문으로 된 코드)
ㄴ name String 팬클럽 이름
ㄴ grade Integer 팬클럽 가입 등급 (1=Ace, 2=Basic, 3=Artist)
ㄴ year Integer ACE 회원의 유효 년 (1년=1, 2년=2, ...), 무료 회원일 경우 0. 참고용으로 사용바라며 periodFrom, periodTo으로 판단하시기 바랍니다.
ㄴ periodFrom String ACE 회원의 유료 시작 일시, 무료일 경우 null
ㄴ periodTo String ACE 회원의 유료 종료 일시, 무료일 경우 null
ㄴ issuedAt String 팬클럽 가입 일자 (yyyy-MM-ddTHH:mm:ss.SSSXXX => 2022-05-27T02:55:50.000Z)
ㄴ updatedAt String 정보 수정 일자 (yyyy-MM-ddTHH:mm:ss.SSSXXX => 2022-05-27T02:55:50.000Z)
실패 응답 - 토큰 Invalid
HTTP/1.1 401
Content-Type: application/json;charset=UTF-8
{
    "path": "https://openapi.smtown.com/api/me/fanclubs",
    "error": "Invalid Token",
    "message": "2a324609ec94f==invalid token value==",
    "timestamp": "2022-04-23T23:16:03.114Z",
    "status": 401
}
실패 응답 - 사용자가 허용하지 않음
HTTP/1.1 401
Content-Type: application/json;charset=UTF-8
{
    "path": "http://localhost:8084/api/me/fanclubs",
    "error": "Access Denied",
    "message": "Insufficient scope for this resource",
    "timestamp": "2022-06-22T20:19:55.653+0000",
    "status": 403
}