유저의 vipscore 조회

개요

VIP 유저 특화 컨텐츠나 서비스를 구성하기 위한 유저의 VIPScore 를 조회 합니다.

vpiscore 조회 API는 Server to server 호출만 지원합니다.

API 접근에 대한 관리가 필요해 해당 API를 호출하는 서버/서버군의 목록을 정리하여 기술PM에게 전달 주셔야 합니다.

기본 정보

API 서버 주소 (api-server-address)

API 테스트 서버 : https://api.insightlab.hybeim.com/test

API 서비스 서버 : https://api.insightlab.hybeim.com

유의 사항

• API 기능 구현은 API 테스트 서버를 이용해서 진행하고, 실제 서비스는 API 서비스 서버를 이용합니다.

• 실제 서비스 전의 부하 테스트는 별도 협의후에 진행해야 합니다.

• 실제 서비스에서 API 를 연동하는 경우에 API 는 비동기적으로 호출해서 응답을 기다리고, timeout 시간 1000 ms 을 두고 그 시간 안에 응답이 없으면 무시하고 넘어가도록 구현합니다.

API 공통 사항

인사이트랩 API 를 사용할 때는 HTTP로 호출할 때 Header 에 API Key 를 함께 전송해야 하고, 서비스 별로 API Key 가 맞지 않으면 호출이 실패합니다.

Header

파라미터	타입	필수 여부	설명
x-api-key	string	Y	서비스(게임) 별로 정해서 전달한 API Key.

주요 응답 코드

API 서버에서 응답하는 중요한 응답 코드는 아래와 같습니다. API 서버외에 API Gateway, 로드밸선서 등에서 일반적인으로 사용하는 HTTP 상태 코드로 응답이 갈 수 있습니다.

HTTP 코드	설명
200	API 요청이 정상적으로 처리된 경우
400	API 파라미터에 오류가 있는 경우
403	x-api-key 값이 잘못된 경우
404	API 요청 url 이 잘못된 경우
500	기타 API 요청 처리 과정에서 오류가 발생한 경우

Request

요청 URL

https://{api-server-address}/v1/vipscore

프로토콜

HTTPS

HTTP메서드

GET

파라미터

파라미터를 쿼리 스트링 형식으로 전달합니다.

파라미터	타입	필수 여부	설명
sid	integer	Y	서비스(게임)의 id
uid	string	Y	사용자의 IMID
ri_uid	integer	N	ri_uid 값이 1이면 응답에 uid 값을 포함한다. ri_uid 파라미터가 없거나 0이면 uid 값을 포함하지 않는다.

Response

응답에 성공하면 결과값을 JSON 형식으로 반환합니다. 실패하면 HTTP 상태 코드 500 을 반환합니다.

요소	타입	필수 여부	설명
vipscore	int	Y	사용자의 vipscore 값
uid	string	N	사용자의 IMID (ri_uid 파라미터가 1인 경우에만 포함)

uid 에 해당하는 사용자가 없거나 검색 대상 기간내에 vipscore 값이 존재하지 않으면 vipscore 값으로 -1 을 반환한다

응답예

1) VIP User

{
    "viopscore": 100
}

2) VIP User (ri_uid = 1)

ri_uid 파라미터의 값이 1인 경우

{
    "uid": "516145617274161928",
    "vipscore": 100
}