Hive Axyl Server API 레퍼런스

Hive Axyl Server API는 앱 서버가 Hive Axyl 서버를 직접 호출하는 Server-to-Server RESTful API입니다. 영수증 검증이나 로그인 토큰 확인처럼 앱 클라이언트를 거치면 위변조될 수 있는 처리, 그리고 푸시 알림 전송처럼 앱 서버에서만 요청할 수 있는 처리에 사용합니다. 이 레퍼런스에서는 제품별 API의 호출 방법, 요청과 응답 형식, 오류 코드를 설명합니다.

호출 전 준비

Hive Axyl Server API를 호출하려면 아래 값이 필요합니다.

값	용도	확인하는 곳
App ID	대상 앱을 지정합니다. 대부분의 API는 요청의 X-App-Id 헤더에 넣고, 리모트 푸시 전송은 요청 본문의 appIds에 넣습니다.	프로젝트 설정 > App ID. 자세한 내용은 App ID를 참조하세요.
Client ID, Client Secret	앱 서버용 인증 토큰을 발급받는 데 사용합니다.	프로젝트 설정 > 보안 키. 자세한 내용은 보안 키를 참조하세요.
인증 토큰	요청의 Authorization 헤더에 넣어 호출 주체를 증명합니다.	토큰 발급으로 발급받습니다.

API마다 Authorization 헤더에 넣는 토큰이 다릅니다. 어떤 토큰을 넣는지는 사용할 토큰 구분을 참조하세요.

기본 URL

요청을 보낼 기본 URL은 제품마다 다릅니다. 결제 API는 운영 환경과 별도로 샌드박스 환경을 제공합니다.

제품	운영	샌드박스
인증 토큰, 계정 및 인증	https://core-api.hiveaxyl.com	-
결제	https://commerce-api.hiveaxyl.com	https://sandbox-commerce-api.hiveaxyl.com
푸시 알림	https://app-api.hiveaxyl.com	-

API 목록

제품	API	설명
인증 토큰	토큰 발급	앱 서버용 인증 토큰을 발급받습니다.
인증 토큰	액세스 토큰 유효성 확인	앱 클라이언트에서 받은 사용자의 액세스 토큰이 유효한지 확인합니다.
계정 및 인증	사전 인가 키 발급	계정 생성, 커스텀 계정 로그인과 연동을 미리 승인하는 grant key를 발급받습니다.
계정 및 인증	유저네임 비밀번호 변경	유저네임 계정의 로그인 비밀번호를 바꿉니다.
결제	소모성 상품 영수증 검증	소모성 상품의 결제 영수증을 마켓에 확인합니다.
결제	구독 상품 영수증 검증	구독 상품의 결제 영수증을 마켓에 확인합니다.
결제	구매 내역 조회	결제 제공자별 구매 내역을 조회합니다.
푸시 알림	리모트 푸시 전송	지정한 사용자에게 푸시 알림을 즉시 보냅니다.

응답과 오류

모든 API는 성공하면 data와 meta로 이루어진 JSON 본문을, 실패하면 오류 유형과 원인을 담은 오류 본문을 반환합니다. 응답 본문의 구조와 제품별 오류 코드는 Hive Axyl Server API 오류 처리를 참조하세요.