Skip to content

๐Ÿ ๋ฉ”์ดํ”Œ์Šคํ† ๋ฆฌ Open API ๋น„๊ณต์‹ TypeScript, JavaScript ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ

Notifications You must be signed in to change notification settings

alstn2468/maplestory-open-api-js

Repository files navigation

๋ฉ”์ดํ”Œ์Šคํ† ๋ฆฌ Open API for JavaScript, TypeScript

๋ฉ”์ดํ”Œ์Šคํ† ๋ฆฌ Open API ๋น„๊ณต์‹ TypeScript, JavaScript ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ

์‚ฌ์šฉ๋ฒ•

  • ํŒจํ‚ค์ง€ ์„ค์น˜
npm install maplestory-open-api-js
pnpm add maplestory-open-api-js
yarn add maplestory-open-api-js
  • APIํ‚ค ์„ค์ •ํ•˜๊ธฐ

APIํ‚ค๋Š” NEXON OPEN API - my ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์—์„œ ๋ฐœ๊ธ‰ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

const API_KEY = process.env.API_KEY;

if (API_KEY) {
  setAPIKey(API_KEY);
}
  • ํ•จ์ˆ˜ ํ˜ธ์ถœํ•˜๊ธฐ
const { ocid } = await getOCID(name);
const cashItemEquipment = await getCharacterCashItemEquipment({ ocid });

์‚ฌ์šฉ ์˜ˆ์‹œ

ํ•ด๋‹น ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋Š” ky ๊ธฐ๋ฐ˜์œผ๋กœ ๊ตฌํ˜„๋˜์–ด ๋ธŒ๋ผ์šฐ์ €์™€ ์„œ๋ฒ„ ํ™˜๊ฒฝ์—์„œ ๋ชจ๋‘ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์ฝ”๋“œ๋Š” ์•„๋ž˜์˜ ๋งํฌ์—์„œ ํ™•์ธ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

ํ•จ์ˆ˜ ๋ชฉ๋ก

๊ฐ ํ•จ์ˆ˜์˜ ์‘๋‹ต ๋ฐ˜ํ™˜ ํƒ€์ž…์€ ๋‚ด๋ถ€ ๊ตฌํ˜„์„ ํ™•์ธํ•ด์ฃผ์„ธ์š”.

๊ณ„์ • ์ •๋ณด ์กฐํšŒ

  • ๊ณ„์ • ์‹๋ณ„์ž(ouid)์กฐํšŒ - getOUID

์บ๋ฆญํ„ฐ ์ •๋ณด ์กฐํšŒ

  • ์บ๋ฆญํ„ฐ ์‹๋ณ„์ž(ocid) - getOCID
  • ๊ธฐ๋ณธ ์ •๋ณด - getCharacterBasic
  • ์ธ๊ธฐ๋„ ์ •๋ณด - getCharacterPopularity
  • ์ข…ํ•ฉ ๋Šฅ๋ ฅ์น˜ ์ •๋ณด - getCharacterStat
  • ํ•˜์ดํผ์Šคํƒฏ ์ •๋ณด - getCharacterHyperStat
  • ์„ฑํ–ฅ ์ •๋ณด - getCharacterPropensity
  • ์–ด๋นŒ๋ฆฌํ‹ฐ ์ •๋ณด - getCharacterAbility
  • ์žฅ์ฐฉํ•œ ์žฅ๋น„ ์ค‘ ์บ์‹œ ์žฅ๋น„ ์ œ์™ธํ•œ ๋‚˜๋จธ์ง€ ์žฅ๋น„ ์ •๋ณด - getCharacterItemEquipment
  • ์žฅ์ฐฉํ•œ ์บ์‹œ ์žฅ๋น„ ์ •๋ณด - getCharacterCashItemEquipment
  • ์žฅ์ฐฉํ•œ ์‹ฌ๋ณผ ์ •๋ณด - getCharacterSymbolEquipment
  • ์ ์šฉ๋ฐ›๊ณ  ์žˆ๋Š” ์„ธํŠธ ํšจ๊ณผ ์ •๋ณด - getCharacterSetEffect
  • ์žฅ์ฐฉ ์ค‘์ธ ํ—ค์–ด, ์„ฑํ˜•, ํ”ผ๋ถ€ ์ •๋ณด - getCharacterBeautyEquipment
  • ์žฅ์ฐฉํ•œ ์•ˆ๋“œ๋กœ์ด๋“œ ์ •๋ณด - getCharacterAndroidEquipment
  • ์žฅ์ฐฉํ•œ ํŽซ ๋ฐ ํŽซ ์Šคํ‚ฌ, ์žฅ๋น„ ์ •๋ณด - getCharacterPetEquipment
  • ์บ๋ฆญํ„ฐ ์Šคํ‚ฌ๊ณผ ํ•˜์ดํผ ์Šคํ‚ฌ ์ •๋ณด - getCharacterSkill
  • ์žฅ์ฐฉ ๋งํฌ ์Šคํ‚ฌ ์ •๋ณด - getCharacterLinkSkill
  • V๋งคํŠธ๋ฆญ์Šค ์Šฌ๋กฏ ์ •๋ณด์™€ ์žฅ์ฐฉํ•œ V์ฝ”์–ด ์ •๋ณด - getCharacterVMatrix
  • HEXA ๋งคํŠธ๋ฆญ์Šค์— ์žฅ์ฐฉํ•œ HEXA ์ฝ”์–ด ์ •๋ณด - getCharacterHEXAMatrix
  • HEXA ๋งคํŠธ๋ฆญ์Šค์— ์„ค์ •ํ•œ HEXA ์Šคํƒฏ ์ •๋ณด - getCharacterHEXAMatrixStat
  • ์บ๋ฆญํ„ฐ ๋ฌด๋ฆ‰๋„์žฅ ์ตœ๊ณ  ๊ธฐ๋ก ์ •๋ณด - getCharacterDojang

์œ ๋‹ˆ์˜จ ์ •๋ณด ์กฐํšŒ

  • ์œ ๋‹ˆ์˜จ ๋ ˆ๋ฒจ ๋ฐ ์œ ๋‹ˆ์˜จ ๋“ฑ๊ธ‰ ์ •๋ณด - getUnion
  • ์œ ๋‹ˆ์˜จ์— ๋ฐฐ์น˜๋œ ๊ณต๊ฒฉ๋Œ€์› ํšจ๊ณผ ๋ฐ ๊ณต๊ฒฉ๋Œ€ ์ ๋ น ํšจ๊ณผ ๋“ฑ ์ƒ์„ธ ์ •๋ณด - getUnionRaider

๊ธธ๋“œ ์ •๋ณด ์กฐํšŒ

  • ๊ธธ๋“œ ์‹๋ณ„์ž(oguild_id) ์ •๋ณด - getOGuildID
  • ๊ธธ๋“œ ๊ธฐ๋ณธ ์ •๋ณด - getGuildBasic

ํ™•๋ฅ  ์ •๋ณด ์กฐํšŒ

  • ์Šคํƒ€ํฌ์Šค ๊ฐ•ํ™” ๊ฒฐ๊ณผ - getStarforceHistory
  • ํ๋ธŒ ์‚ฌ์šฉ ๊ฒฐ๊ณผ - getCubeHistory

๋žญํ‚น ์ •๋ณด ์กฐํšŒ

  • ์ข…ํ•ฉ ๋žญํ‚น ์ •๋ณด - getOverallRanking
  • ์œ ๋‹ˆ์˜จ ๋žญํ‚น ์ •๋ณด - getUnionRanking
  • ๊ธธ๋“œ ๋žญํ‚น ์ •๋ณด - getGuildRanking
  • ๋ฌด๋ฆ‰๋„์žฅ ๋žญํ‚น ์ •๋ณด - getDojangRanking
  • ๋” ์‹œ๋“œ ๋žญํ‚น ์ •๋ณด - getTheSeedRanking
  • ์—…์  ๋žญํ‚น ์ •๋ณด - getAchievementRanking
LAST UPDATED AT 2024.01.10

About

๐Ÿ ๋ฉ”์ดํ”Œ์Šคํ† ๋ฆฌ Open API ๋น„๊ณต์‹ TypeScript, JavaScript ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published