MapleStory.OpenAPI 2.5.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package MapleStory.OpenAPI --version 2.5.0                
NuGet\Install-Package MapleStory.OpenAPI -Version 2.5.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MapleStory.OpenAPI" Version="2.5.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MapleStory.OpenAPI --version 2.5.0                
#r "nuget: MapleStory.OpenAPI, 2.5.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MapleStory.OpenAPI as a Cake Addin
#addin nuget:?package=MapleStory.OpenAPI&version=2.5.0

// Install MapleStory.OpenAPI as a Cake Tool
#tool nuget:?package=MapleStory.OpenAPI&version=2.5.0                

MapleStory OpenAPI C# Library

NuGet

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

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

(English document is HERE)

Installation

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

<PackageReference Include="MapleStory.OpenAPI" Version="2.5.0" />

Usage

API Key

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

Sample Code

using MapleStory.OpenAPI;

var apiKey = "{Your API Key}";
var api = new MapleStoryAPI(apiKey);
var dateTimeOffset = new DateTimeOffset(2023, 10, 15, 0, 0, 0, TimeSpan.FromHours(9));

// run your code
try
{
    var response = await api.GetCubeHistory(1000, dateTimeOffset);

    var count = response.Count;
    var cubeHistory = response.CubeHistory;
    var nextCursor = response.NextCursor;

    Console.WriteLine("You used " + count + " cubes.");
}
// exception handling
catch (MapleStoryAPIException e)
{
    // handle MapleStoryApiException
}
catch (HttpRequestException e)
{
    // handle HttpRequestException
}

Exception Handling

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

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

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

ErrorCode Description
OPENAPI00001 서버 내부 오류
OPENAPI00002 권한이 없는 경우
OPENAPI00003 유효하지 않은 식별자
OPENAPI00004 파라미터 누락 또는 유효하지 않음
OPENAPI00005 유효하지 않은 API KEY
OPENAPI00006 유효하지 않은 API PATH
OPENAPI00007 API 호출량 초과
OPENAPI00009 데이터 준비 중
OPENAPI00010 서비스 점검 중
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.7.2 88 10/3/2024
2.7.1 112 8/14/2024
2.7.0 103 7/19/2024
2.6.1 89 7/8/2024
2.6.0 101 6/14/2024
2.5.0 139 4/9/2024
2.4.1 125 2/21/2024
2.4.0 127 1/26/2024
2.3.2 153 1/9/2024
2.3.1 125 1/4/2024
2.3.0 113 12/31/2023
2.2.0 124 12/27/2023
2.1.1 139 12/24/2023
2.1.0 116 12/23/2023
2.0.0 124 12/14/2023
1.1.0 146 12/3/2023
1.0.1 127 11/28/2023
1.0.0 132 11/18/2023