넥슨의 MapleStory OpenAPI를 Javascript 환경에서 사용할 수 있게 해주는 라이브러리입니다.
다른 언어로 작성된 패키지는 여기에서 확인할 수 있습니다.
(English document is HERE)
npm 기반 프로젝트에 아래 정보를 입력하여 패키지를 추가하세요:
npm install maplestory-openapi@2.5.0 # Replace with the latest version라이브러리를 사용하기 전에 Nexon Open API 콘솔에서 애플리케이션을 등록하고 api key를 발급 받으세요.
- CommonJS, ESM 지원: 이 라이브러리는 CommonJS 와 ESM 방식을 모두 지원합니다.
const {MapleStoryApi, MapleStoryApiError} = require('maplestory-openapi'); // CommonJSimport {MapleStoryApi, MapleStoryApiError} from 'maplestory-openapi'; // ESM- TypeScript 지원: 타입 정의가 포함되어 있으므로 타입스크립트 환경에서도 사용 가능합니다.
const {MapleStoryApi, MapleStoryApiError} = require('maplestory-openapi');
const apiKey = '{Your API Key}';
const api = new MapleStoryApi(apiKey);
api.getCubeHistory(1000, {
year: 2023,
month: 10,
day: 15
})
.then((dto) => {
const {count, cubeHistory, nextCursor} = dto;
console.log('You used ' + count + ' cubes.');
})
.catch((e) => {
if (e instanceof MapleStoryApiError) {
// handle MapleStoryApiError
} else {
// handle other errors
}
console.log(e);
});MapleStory OpenAPI 가이드에 서술된 에러 사유를 MapleStoryApiError를 통해 예외 처리 해야합니다.
MapleStoryApi는 특정 상태의 예외를 발생시키지 않도록 설계되었으나, 라이브러리를 사용하는 개발자의 실수로 인해 여전히 일부 상태의 예외가 발생할 수 있습니다.
따라서 아래 표에 설명된 MapleStoryApiErrorCode 목록을 기반으로 MapleStoryApiError를 예외 처리하시기 바랍니다.
| ErrorCode | Description |
|---|---|
| OPENAPI00001 | 서버 내부 오류 |
| OPENAPI00002 | 권한이 없는 경우 |
| OPENAPI00003 | 유효하지 않은 식별자 |
| OPENAPI00004 | 파라미터 누락 또는 유효하지 않음 |
| OPENAPI00005 | 유효하지 않은 API KEY |
| OPENAPI00006 | 유효하지 않은 API PATH |
| OPENAPI00007 | API 호출량 초과 |
| OPENAPI00009 | 데이터 준비 중 |
| OPENAPI00010 | 서비스 점검 중 |