개인화 회원 (카카오 모먼트)
연동 방식
https 프로토콜을 이용한 Rest API
필수 값
| 이름 | 내용 |
|---|---|
| API Key | 설정 페이지에서 발급한 API Key 값 |
요청 주소
공통 사항
요청 방법
Rest API 요청 시 Header에 x-api-key 키로 API Key를 값으로 포함해야 합니다.
curl --location --request GET 'https://api.groobee.io/<요청주소>' \
--header 'x-api-key: <발급 받은 API Key 값>'
응답 결과
JSON으로 응답하며 형태는 아래를 참고해 주세요.
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": <요청한 엔드 포인트의 응답 값>
}
processCode 코드값
| 코드 값 | 상태 | 설명 |
|---|---|---|
| 0 | 성공 | |
| 1 | 부분 성공 | |
| -1000 | 실패 | 요청 시 Header에 x-api-key 미존재 |
| -1001 | 실패 | 고객사 미존재 |
| -1002 | 실패 | 고객사 미승인 상태(승인 필요) |
| -1003 | 실패 | 고객사 계약 기간 만료 |
| -1004 | 실패 | 데이터 초과 |
| -9997 | 실패 | 올바르지 않은 데이터 |
| -9998 | 실패 | http 관련 에러 |
| -9999 | 실패 | 요청 API 서버 에러 |
엔드 포인트
회원 조회
회원을 조회하는 API
단건 조회
단건 조회 요청 형식
| Method | URI | 요청/응답 형식 |
|---|---|---|
| GET | /v1/members?memberId=<회원 아이디> | JSON |
응답 데이터
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": [
{
"memberId": <회원 아이디>,
"phoneNumber": <회원 전화번호(저장된 형식과 무관하게 000-0000-0000 와 같이 하이픈이 있는 형식)>,
"name":<회원 이름>
}
]
}
다건 조회
회원을 100건씩 조회합니다. 페이지 번호가 없으면 기본 1로 적용합니다.
다건 조회 요청 형식
| Method | URI | 요청/응답 형식 |
|---|---|---|
| GET | /v1/members?pageNo=<페이지 번호> | JSON |
응답 데이터
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": {
"data" : [
{
"memberId": <회원 아이디>,
"phoneNumber": <회원 전화번호(저장된 형식과 무관하게 000-0000-0000 와 같이 하이픈이 있는 형식)>,
"name":<회원 이름>
},
...
],
"pageNo" : <현재 페이지>,
"pageSize" : <페이지 크기>,
"totalPageCount" : <전체 페이지 수>
}
}
회원 정보 저장 / 수정
회원 정보를 저장 및 수정하는 API ※ 회원 아이디가 중복이면 UPDATE, 중복이 아니면 INSERT 처리합니다.
요청 형식
| Method | URI | 요청/응답 형식 |
|---|---|---|
| POST | /v1/members | JSON |
매개변수
| Parameter | Parameter Name | Description | 필수 |
|---|---|---|---|
| phoneNumber | 회원 전화번호(1X-XXX-XXXX, 1X-XXXX-XXXX, 01X-XXX-XXXX, 01XXXXX- XXXX, 1XXXXXXXX, 1XXXXXXXXX, 01XXXXXXXX, 01XXXXXXXXX) 형식 지원 | O | |
| name | 회원 이름 | X |
요청 데이터
등록할 회원 정보들을 배열로 요청합니다.
[
{
"memberId":<회원 아이디>,
"phoneNumber":<회원 전화번호>,
"name":<회원 이름>
}
...
]
응답 데이터
"processCode" : 1(부분 성공) 회원 아이디가 없거나, 전화번호 형식 불일치의 이유로 부분적으로 실패가 존재할 수 있 습니다.
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": [
{
"memberId" : <실패된 회원 id>,
"phoneNumber" : <실패된 회원 전화번호>,
"name" : <실패된 회원 이름>,
"failureCode" : <F00 : 회원아이디가 없고 전화번호 형식 불일치, F01 : 회원 아이디가 없음, F02 : 전화번호 형식 불일치>
}
]
}
회원 정보 삭제
회원 정보들을 삭제하는 API
요청 형식
| Method | URI | 요청/응답 형식 |
|---|---|---|
| DELETE | /v1/members | JSON |
매개 변수
| Parameter | Parameter Name | Description |
|---|---|---|
| users (max 1000) | memberId | 회원 아이디 |
요청 데이터
삭제할 회원 아이디들을 배열로 요청합니다.
[
<회원 아이디>, ...
]
응답 데이터
성공 여부와 상관없이 processValue 키에 해당 되는 값은 없습니다.
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": ""
}
