시작하기

시작하기

먼저 개발자 사이트에서 로그인 후 api_key를 발급받아야 합니다.

응답 확인 도구

요청에 대한 응답을 확인하기 위해서는 도구가 필요할 것입니다.
여러 도구가 있지만 포스트맨을 추천해드리겠습니다.
그렇지만 롤 API에는 GET 메소드 밖에 없기 때문에 인터넷 브라우저의 주소창을 가지고 테스트할 수 있습니다.

API가 처음이세요?

API 문서들을 보면 생략된 암묵적인 규칙이 있습니다. 기본적인 규칙은 다음과 같은 것입니다.

  • Base URL은 생략한다

    이 문서에서 언급되는 모든 요청에는 앞에 이 주소(Base URL)가 붙어 있다고 가정합니다. https://kr.api.riotgames.com/ 이런 식으로요. https://kr.api.riotgames.com/lol/summoner...

  • some/url/{어떤값}

    유동적인 값을 넣는 자리는 이런 식으로 표현됩니다.
    중괄호 {} 안에 내용을 넣지말고 ‘{ ~ }’를 통째로 교체해주세요.

  • 인증이 필요한 EndPoint가 대부분

    인증 형식은 API마다 다릅니다.
    여기 롤 API처럼 URL 파라미터로 토큰값을 넣는 방식이 있을 수 있고
    header에 토큰을 넣을 수도 있습니다.
    어떤 방식이든 한번 설명을 한 후에는
    각 요청(EndPoint)마다 구체적으로 명시되지 않고
    ‘인증이 필요하다/필요하지 않다’ 여부만 표시되어 있을 것입니다.

  • URL 파라미터

    id가 URL 파라미터로 들어간 예)
    https://some.com?id=123 필수인 파라미터가 있고, 필수가 아닌 파라미터가 있습니다.
    보통 필수가 아닌 파라미터를 (optional)이라고 표현해줍니다.

어플리케이션에서의 활용

개인적인 테스트를 넘어서 어플리케이션에 적용하고자 한다면,
개발자 사이트에서 본인 서버 url 인증을 받아야 합니다. 안내에 따라서 application 신청을 하고
발급받은 인증코드를 본인의 웹서버 루트 지점에 riot.txt라는 파일로 저장하고 인증을 받으세요.

GET ?api_key={Your Key} 인증

모든 요청 끝에 URL파라미터로 api_key가 들어가야 합니다.

응답코드

Success

  • 성공 시 200 OK를 돌려줍니다.
  • GET 메소드의 경우, 해당 모델의 DTO를 돌려주는 경우가 많습니다.

Error

  • 에러 처리가 되어있는 경우, 메세지와 코드가 함께 전달됩니다.

{ "status": { "message": "Unauthorized", "status_code": 401 } }

GET /lol/static-data/v3/champions 챔피언의 리소스 조회

/lol/static-data/v3/champions 챔피언의 리소스를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고
  • 가능한 URL 파라미터
KEY VALUE TYPE etc
version 7.9.1, … string data dragon버전
champListData all, allytips, altimages, blurb, enemytips, image, info, lore, partype, passive, recommended, skins, spells, stats, tags string  
dataById true/false boolean  
locale en_US, … string  

응답

챔피언의 리소스 데이터를 리턴합니다.

{ "type": "champion", "format": "full", "version": "7.9.1", "data": { "Jax": {}, ... }, "keys": { "1": "Annie", ... } }

GET /lol/match/v3/timelines/by-match/{matchId} 타임라인 조회

/lol/match/v3/timelines/by-match/{matchId} 해당 경기의 시간별 정보를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

경기의 타임라인 정보를 리턴합니다.

{ "frames": [ { "participantFrames": { "1": { "participantId": 1, "position": { "x": 561, "y": 581 }, "currentGold": 500, "totalGold": 500, "level": 1, "xp": 0, "minionsKilled": 0, "jungleMinionsKilled": 0, "dominionScore": 0, "teamScore": 0 }, 2: { ... },... }, "events": [], "timestamp": 169 },... ], "frameInterval": 60000 }

GET /lol/match/v3/matchlists/by-account/{accountId} 경기 상세 조회

/lol/match/v3/matchlists/by-account/{accountId} 경기 리스트를 상세 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고
  • 가능한 URL 쿼리 파라미터
    beginTime, endIndex, season, champion, beginIndex, queue, endTime

응답

해당하는 아이디의 경기 DTO를 리턴합니다.

{ "matches": [...] "startIndex": 0, "endIndex": 1662, "totalGames": 1662, }

GET /lol/match/v3/matchlists/by-account/{accountId}/recent 최근 경기 조회

/lol/match/v3/matchlists/by-account/{accountId}/recent 경기 리스트 20개를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고
  • 가능한 URL 쿼리 파라미터
    beginTime, endIndex, season, champion, beginIndex, queue, endTime

응답

해당하는 아이디의 경기 DTO를 리턴합니다.

{ "matches": [...] "startIndex": 0, "endIndex": 1662, "totalGames": 1662, }

GET /lol/match/v3/matches/by-tournament-code/{tournamentCode}/ids 토너먼트의 경기 ID 조회

/lol/match/v3/matches/by-tournament-code/{tournamentCode}/ids 해당 토너먼트 경기의 ID들을 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

경기의 ID를 리턴합니다.

준비중입니다

GET /lol/match/v3/matches/by-tournament-code/{tournamentCode}/ids 토너먼트의 경기 조회

/lol/match/v3/matches/by-tournament-code/{tournamentCode}/ids 토너먼트의 경기를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

경기 정보를 리턴합니다.

준비중입니다

GET /lol/match/v3/matches/{matchId} 경기 정보 조회

/lol/match/v3/matches/{matchId} 경기ID로 경기 정보를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

해당하는 아이디의 경기 DTO를 리턴합니다.

{ "gameId": 2804504366, "platformId": "KR", "gameCreation": 1493447504945, "gameDuration": 1221, "queueId": 2, "mapId": 11, "seasonId": 8, "gameVersion": "7.8.184.113", "gameMode": "CLASSIC", "gameType": "MATCHED_GAME", "teams": [...], "participants": [...], "participantIdentities": [...] }

For errors responses, see the response status codes documentation.

GET /lol/platform/v3/champions 모든 챔피언 상태 조회

/lol/platform/v3/champions 모든 챔피언의 상태를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고
  • 가능한 URL 파라미터
KEY VALUE TYPE
freeToPlay true,false boolean

응답

모든 챔피언의 상태를 리턴합니다.

{ "champions": [ { "id": 63, "active": true, "botEnabled": true, "freeToPlay": true, "botMmEnabled": true, "rankedPlayEnabled": true }, ... ] }

For errors responses, see the response status codes documentation.

GET /lol/platform/v3/champions/{id} 챔피언 상태 조회

/lol/platform/v3/champions/{id} 해당 챔피언의 상태를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

해당 챔피언의 상태를 리턴합니다.

{ "id": 63, "active": true, "botEnabled": true, "freeToPlay": true, "botMmEnabled": true, "rankedPlayEnabled": true }

GET /lol/summoner/v3/summoners/by-name/{소환사명} 소환사명으로 조회

/lol/summoner/v3/summoners/by-name/{소환사명} 소환사명으로 유저 정보를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

해당하는 아이디의 정보를 리턴합니다.

{ "id": 1135567, "accountId": 439488, "name": "SKT T1 Faker", "profileIconId": 7, "revisionDate": 1493423674000, "summonerLevel": 30 }

For errors responses, see the response status codes documentation.

GET /lol/summoner/v3/summoners/by-account/{계정번호} 계정으로 조회

/lol/summoner/v3/summoners/by-account/{계정번호} 계정고유번호로 유저 정보를 조회합니다.

요청

  • 발급받은 api_key를 URL파라미터에 포함해야 합니다. 시작하기 참고

응답

해당하는 아이디의 정보를 리턴합니다.

{ "id": 1135567, "accountId": 439488, "name": "SKT T1 Faker", "profileIconId": 7, "revisionDate": 1493423674000, "summonerLevel": 30 }

For errors responses, see the response status codes documentation.