MapleStory.OpenAPI 2.9.0

MapleStory OpenAPI C# Library

넥슨의 MapleStory OpenAPI를 C# 환경에서 사용할 수 있게 해주는 라이브러리입니다.

다른 언어로 작성된 패키지는 여기에서 확인할 수 있습니다.

(English document is HERE)

Installation

NuGet 기반 프로젝트에 아래 정보를 입력하여 패키지를 추가하세요:

dotnet add package MapleStory.OpenAPI

Usage

API Key

라이브러리를 사용하기 전에 Nexon Open API 콘솔에서 애플리케이션을 등록하고 api key를 발급 받으세요.

Sample Code

아래 코드는 닉네임을 바탕으로 특정 캐릭터의 식별자를 조회한 후 캐릭터의 기본 정보를 조회하는 예시입니다.

using MapleStory.OpenAPI;

var apiKey = "{Your API Key}";
var api = new MapleStoryAPI(apiKey);

// run your code
try
{
    var character = await api.GetCharacter("{Your Character Name}");
    var characterBasic = await api.GetCharacterBasic(character.OCID);

    Console.WriteLine(characterBasic.ToJson());
}
// exception handling
catch (MapleStoryAPIException e)
{
    // handle MapleStoryApiException
}
catch (HttpRequestException e)
{
    // handle HttpRequestException
}

더 많은 예시는 아래 링크의 테스트 케이스에서 확인할 수 있습니다.

• 캐릭터 정보 조회
• 유니온 정보 조회
• 길드 정보 조회
• 확률 정보 조회
• 랭킹 정보 조회
• 공지 정보 조회

Exception Handling

MapleStory OpenAPI 가이드에 서술된 에러 사유를 MapleStoryAPIException를 통해 예외 처리 해야합니다.

MapleStoryAPI는 특정 상태의 예외를 발생시키지 않도록 설계되었으나, 라이브러리를 사용하는 개발자의 실수로 인해 여전히 일부 상태의 예외가 발생할 수 있습니다.

따라서 아래 표에 설명된 MapleStoryAPIErrorCode 목록을 기반으로 MapleStoryAPIException를 예외 처리하시기 바랍니다.