Neople SDK JS시작하기
Neople SDK JS 설치 및 설정 방법 배우기
시작하기
Neople SDK는 던전앤파이터와 사이퍼즈 게임 API를 지원하는 네오플 오픈 API용 TypeScript SDK입니다.
주요 특징:
- TypeScript 지원: 모든 API에 대한 타입 안전성
- 다중 HTTP 어댑터 지원: Fetch, Axios, Got, Node-fetch 어댑터 선택 가능
- URL Builder 지원: URL 추출 가능
- 포괄적 오류 처리: 상세한 오류 정보와 재시도 메커니즘
설치
npm 또는 선호하는 패키지 매니저를 사용하여 패키지를 설치하세요:
npm install neople-sdk-jsyarn add neople-sdk-jspnpm add neople-sdk-js요구사항
- Node.js 18 이상
- TypeScript 지원 (권장)
- 네오플 오픈 API 키
API 키
각기 다른 게임 API를 위해 별도의 API 키가 필요합니다:
- 던전앤파이터 API 키: 던전앤파이터 게임 데이터 접근에 필요
- 사이퍼즈 API 키: 사이퍼즈 게임 데이터 접근에 필요
네오플 오픈 API 웹사이트에서 API 키를 발급받으세요.
환경 설정
프로젝트 루트에 .env 파일을 생성하세요:
NEOPLE_DF_API_KEY=your_dungeon_fighter_api_key
NEOPLE_CYPHERS_API_KEY=your_cyphers_api_key빠른 시작
던전앤파이터 클라이언트
import { NeopleDFClient } from 'neople-sdk-js';
const dfClient = new NeopleDFClient(process.env.NEOPLE_DF_API_KEY);
// 캐릭터 검색
const characters = await dfClient.searchCharacter('홍길동');
console.log(characters);
// 캐릭터 정보 조회
if (characters.rows.length > 0) {
const character = await dfClient.getCharacter(
characters.rows[0].serverId,
characters.rows[0].characterId
);
console.log(character);
}사이퍼즈 클라이언트
import { NeopleCyphersClient } from 'neople-sdk-js';
const cyphersClient = new NeopleCyphersClient(
process.env.NEOPLE_CYPHERS_API_KEY
);
// 플레이어 검색
const players = await cyphersClient.searchPlayer('플레이어명');
console.log(players);지원 환경
- Node.js 백엔드 애플리케이션
- Next.js API 라우트
- 서버리스 함수 (Vercel, AWS Lambda 등)
- Express.js 서버
- 브라우저 환경 (CORS 제한으로 인해 지원되지 않음)
HTTP 어댑터 선택
SDK는 여러 HTTP 클라이언트를 지원합니다:
// 기본값: Fetch API (Node.js 18+ 권장)
const client = new NeopleDFClient(apiKey);
// 또는 명시적으로 어댑터 선택
const client = new NeopleDFClient(apiKey, {
httpAdapter: 'fetch', // 'fetch' | 'axios' | 'got' | 'node-fetch'
});자세한 내용은 HTTP 어댑터 가이드를 참조하세요.
오류 처리
SDK는 포괄적인 오류 처리를 제공합니다:
try {
const character = await dfClient.getCharacter('cain', 'characterId');
} catch (error) {
console.error('API 오류:', error.message);
}