API 가이드

개요

Stageup API는 개발자들이 자신의 애플리케이션이나 서비스를 Stageup 플랫폼과 연동할 수 있도록 설계되었습니다. API를 통해 주문 정보, 상품 정보, 고객 데이터 등을 프로그래밍 방식으로 액세스하고 관리할 수 있습니다.

인증 방법

Stageup API를 호출하려면 다음과 같은 인증 방법을 사용해야 합니다:

1. API 키 인증: 관리자 페이지에서 발급받은 API 키를 요청 헤더에 포함시켜 인증합니다.

2. API-KEY: 고객마다 자동으로 API KEY 가 발급됩니다. 해당 API-KEY 로 요청을 하게됩니다.

웹훅(Webhook) 기능

Stageup은 다양한 이벤트에 대한 웹훅을 제공합니다. 웹훅을 설정하면 특정 이벤트(예: 새 주문, 결제 완료, 배송 상태 변경 등)가 발생할 때 실시간으로 알림을 받을 수 있습니다.

웹훅 설정 방법

1. 관리자 페이지의 API 설정 메뉴로 이동합니다.

2. 웹훅 URL을 등록합니다.

3. 수신할 이벤트 유형을 선택합니다.

4. 웹훅 서버의 보안을 위한 서명 키를 설정합니다.

API 대시보드 화면

웹훅(Webhook) 종류

1. 일반 웹훅: 기본적인 웹흑 설정으로, 테스트/운영 환경별로 URL을 설정할 수 있습니다.

2. 게임팟 웹훅: 게임팟 서비스와 연동하여 결제, 인증 등의 이벤트를 처리할 수 있습니다. 게임팟에서 제공하는 API를 통해 자동으로 웹훅이 설정됩니다.

3. 고급 웹훅: HTTP 메서드, 헤더, 바디 템플릿 등을 직접 설정할 수 있는 고급 웹훅입니다. 복잡한 통합 요구사항이 있는 경우 사용하세요.

웹훅 테스트

웹훅 서버를 설정한 후에는 관리자 페이지에서 테스트 이벤트를 발송하여 정상 작동 여부를 확인할 수 있습니다.

웹훅 테스트 화면

에러 처리

API 응답은 표준 HTTP 상태 코드를 사용합니다:

• 200: 성공

• 400: 잘못된 요청

• 401: 인증 실패

• 403: 권한 없음

• 404: 리소스 없음

• 500: 서버 오류

모든 오류 응답은 문제의 원인을 식별하는 데 도움이 되는 오류 코드와 메시지를 포함합니다.

지원 및 문의

API 사용 중 문제가 발생하거나 추가 정보가 필요한 경우 다음 채널을 통해 지원을 받을 수 있습니다:

• 이메일: [e-mail]

• 개발자 디스코드: https://discord.gg/PVZDh8dJ

API 변경 및 업데이트

API 변경 사항과 새로운 기능은 개발자 블로그와 이메일 뉴스레터를 통해 공지됩니다.