푸시 알림 이력

회원 아이디로 최근 1주일간 수신된 푸시 리스트를 반환

연동 방식

https 프로토콜을 이용한 Rest API

---

필수값

이름	내용
API Key	설정 페이지에서 발급한 API Key 값

---

요청 주소

https://api.groobee.io

---

요청 방법

Rest API 요청 시 Header에 x-api-key 키로 API Key를 값으로 포함해야 합니다.

curl --location --request GET 'https://api.groobee.io/<요청주소>' \
--header 'x-api-key: <발급 받은 API Key 값>'

• API key 확인 방법

  • https://app.groobee.io/ 접속하여 계정 로그인

  • 설정 > 사이트 > 사이트 설정 > Key 관리에서 key 생성 후 확인 가능

요청 형태

Method	URI	요청/응답 형식	설명
GET	/v1/push?memberId=<회원 ID>	JSON	옵션 필드 미사용 시
GET	/v1/push?memberId=<회원 ID>&fields=<옵션 필드>	JSON	옵션 필드 사용 시 ※ fields=<옵션 필드>는 필수가 아닌 선택 파라미터

응답 결과

JSON으로 응답하며 형태는 아래를 참고해 주세요.

{
    "httpStatus": {
        "code": <http status code>,
        "reasonPhrase": <http status 내용>
    },
    "processCode": <결과 코드>,
    "processValue": <요청한 엔드포인트의 응답값>
}

processCode 코드값

코드 값	상태	설명
0	성공	-
-1000	실패	요청 시 Header에 x-api-key 미존재
-1001	실패	고객사 미존재
-1002	실패	고객사 미승인 상태 (승인 필요)
-1003	실패	고객사 계약기간 만료
-9998	실패	http 관련 에러
-9999	실패	요청 API 서버 에러

응답 데이터 예시

{
     "httpStatus": {
         "code": <http status code>,
         "reasonPhrase": <http status 내용>
     },
     "processCode": <결과 코드>,
     "processValue": [
             {
                 "title": <푸시 제목>,
                 "content": <내용>,
                 "iconPath": <펼친 이미지 URL>,
                 "receivedDtm": <발송일자>,
                 "urlCd": <링크타입 - AP:앱실행, DP:딥링크, WB:웹브라우저실행>,
                 "url_and": <안드로이드 딥링크 or URL>,
                 "url_ios": <iOS 딥링크 or URL>,
                 "osCd": <디바이스 타입 - IS:iOS, AD:Android>,
                 "goalCd":  <알림 목적 (fields에 goalCd가 있을 경우에만 노출) - AD: 광고성 , IN: 정보성>
             },
             ... (조회일로부터 1주일 내의 회원 Push 이력)
     ]
}

---