maplestory-openapi 1.1.0 → 2.1.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/maplestory-openapi)](https://www.npmjs.com/package/maplestory-openapi)
 
-This JavaScript library enables the use of the MapleStory OpenAPI provided by Nexon.
+This JavaScript library enables the use of the MapleStory OpenAPI of Nexon.
 
 Packages written in other languages can be found [HERE](https://github.com/SpiralMoon/maplestory.openapi).
 
@@ -13,11 +13,15 @@ Packages written in other languages can be found [HERE](https://github.com/Spira
 Install the latest version of the JavaScript/TypeScript library in your npm project:
 
 ```bash
-npm install maplestory-openapi@1.1.0 # Replace with the latest version
+npm install maplestory-openapi@2.1.0 # Replace with the latest version
 ```
 
 ## Usage
 
+### API Key
+
+Before using the library, register your application and obtain an **api key** from the [Nexon Open API Console](https://openapi.nexon.com/my-application/).
+
 ### Supports
 
 1. **CommonJS, ESM Support**: The library supports both CommonJS and ESM usage.
@@ -39,13 +43,13 @@ const {MapleStoryApi, MapleStoryApiError} = require('maplestory-openapi');
 const apiKey = '{Your API Key}';
 const api = new MapleStoryApi(apiKey);
 
-api.getCubeResult(1000, {
+api.getCubeHistory(1000, {
     year: 2023,
     month: 10,
     day: 15
 })
     .then((dto) => {
-        const {count, cubeHistories, nextCursor} = dto;
+        const {count, cubeHistory, nextCursor} = dto;
 
         console.log('You used ' + count + ' cubes.');
     })
@@ -62,17 +66,18 @@ api.getCubeResult(1000, {
 
 ### Exception Handling
 
-Handle `MapleStoryApiError` to safely make calls, ensuring that specific Status defined in the [MapleStory OpenAPI Guide](https://developers.nexon.com/Maplestory/guides) are not encountered.
+Handle `MapleStoryApiError` to safely make calls, ensuring that specific Status defined in the [MapleStory OpenAPI Guide](https://openapi.nexon.com/guide/request-api) are not encountered.
 
 While `MapleStoryApi` is designed to prevent the occurrence of certain Status, exceptions may arise due to developer mistakes.
 
-Therefore, it's recommended to use `MapleStoryApiError` for exception handling based on the Status list described in the table below.
-
-| Status | Message                                                 |
-|--------|---------------------------------------------------------|
-| 400    | Request format error (incorrect parameter input)        |
-| 401    | Unauthorized service (unsupported service, service type) |
-| 403    | Unauthorized AccessToken usage                          |
-| 429    | AccessToken's request allowance (Rate Limit) exceeded   |
-| 500    | Internal server error                                   |
-| 504    | Internal server processing timeout                      |
+Therefore, it's recommended to use `MapleStoryApiError` for exception handling based on the `MapleStoryApiErrorCode` list described in the table below.
+
+| ErrorCode    | Description                                     |
+|--------------|-------------------------------------------------|
+| OPENAPI00001 | Internal server error                           |
+| OPENAPI00002 | Access denied                                   |
+| OPENAPI00003 | Invalid identifier                              |
+| OPENAPI00004 | Request format error (incorrect parameter input) |
+| OPENAPI00005 | Invalid api key                                 |
+| OPENAPI00006 | Invalid api path                                |
+| OPENAPI00007 | Request allowance (Rate Limit) exceeded         |