회원 API v2 : 카카오 모먼트 앱 유저 아이디 (갤러리아몰 오픈)
오프사이트 캠페인의 발송 시 사용되는 회원의 정보를 그루비에 전송하는 API 입니다.회원 API v1 과 v2는 혼용하여 사용할 수 없습니다.
회원 정보 조회
설명
등록한 회원 정보를 조회합니다.
회원 정보는 회원 ID, 회원 앱 유저 아이디를 쿼리 파라미터로 전달하여 조회할 수 있습니다. ※ '회원 정보'란 회원에게 카카오 모먼트(카카오 모먼트 사용 등록한 고객사) 메시지를 발송하기 위해 등록한 고객사의 회원 정보 입니다.
기본 정보
GET
https://api.groobee.io/v2/users/sms
API Key
요청 헤더
x-api-key
x-api-key: ${x-api-key}
O
Content-Type
Content-Type: application/json
O
쿼리 파라미터
memberId
String
조회 회원의 ID
O/X
둘 중 하나는 필수로 입력되어야 합니다.
appUserId
String
조회 회원의 앱 유저 아이디
X/O
응답
응답은 그루비 API 공통응답 형식의 "processValue" 필드에 조회한 회원의 정보를 JSON 배열로 반환합니다.
memberId
String
조회 회원의 ID
appUserId
String
조회 회원의 앱 유저 아이디
name
String
조회 회원의 이름
name 필드는 회원 정보 저장/수정에서 정보를 전송하지 않으면 정보가 없는 상태로 응답합니다.
예제
요청(회원 ID) 검색
응답
회원 ID로 조회 시 등록한 회원 ID의 목록이 출력됩니다.
※ 회원 API v2 에서는 appUserId 를 회원정보의 유일 값으로 사용합니다.
요청(회원 앱 유저 아이디 검색)
응답
앱 유저 아이디로 조회 시 등록한 회원의 정보가 출력됩니다.
※ 회원 API v2 에서는 appUserId를 회원 정보의 유일 값으로 사용합니다.
회원 정보 저장/수정
설명
회원 정보를 저장/수정 합니다.
카카오 모먼트 사용 등록한 고객사가 회원에게 카카오 모먼트 메시지를 발송하기 위해 회원 정보를 저장/수정 합니다.
‘저장/수정' 시 등록된 회원의 정보가 없으면 저장되고 회원의 정보가 있으면 '앱 유저 아이디’를 기준으로 회원의 정보가 변경됩니다.
회원 정보 저장 시 API v2 에서는 앱 유저 아이디 중복 입력을 확인합니다. 전송하는 정보에 앱 유저 아이디가 중복되면 중복된 정보를 제외하고 입력됩니다.
기본 정보
POST
https://api.groobee.io/v2/users/sms
API Key
요청 헤더
x-api-key
x-api-key: ${x-api-key}
O
Content-Type
Content-Type: application/json
O
요청 본문
요청 본문으로 전송할 수 있는 최대 데이터 행은 1,000 개 입니다. 1,000 개가 넘으면 오류를 반환합니다.
memberId
String
저장/수정 회원의 ID
O
-
appUserId
String
저장/수정 회원의 앱 유저 아이디
O
-
name
String
저장/수정 회원의 이름
X
제한 길이 20자
응답
회원 정보 '저장/수정' 응답은 성공/실패 시 모두 정상 응답하며 입력받은 회원 정보의 오류가 있으면 정상 데이터는 처리하고 오류 데이터 행을 오류코드와 함께 반환합니다.
memberId
String
저장/수정 회원의 ID
-
appUserId
String
저장/수정 회원의 앱 유저 아이디
-
name
String
저장/수정 회원의 이름
failureCode
String
입력한 행의 실패코드
"F04" : 회원 ID가 없고 앱 유저 아이디 없음
"F05" : 회원 ID가 없음
"F06" : 앱 유저 아이디 없음
"F03" : 이름 길이 초과(제한 20자)
"F12" : 앱 유저 아이디 중복 행 존재
failureMessage
String
실패 코드에 대한 세부내용
name 필드는 회원 정보 저장/수정에서 정보를 전송하지 않으면 정보가 없는 상태로 저장됩니다.
예제
요청(회원 ID) 검색
응답(성공)
응답(실패)
데이터 오류가 있을 경우 실패 응답에 실패한 데이터 및 오류코드를 함께 응답합니다.
회원 정보 삭제
설명
회원 정보를 삭제합니다.
입력된 회원의 ID를 기준으로 요청한 회원의 정보를 모두 삭제합니다.
POST 요청으로 수행되며, 쿼리 파라미터 'delete' 를 인자로 추가합니다.
삭제 시 입력되었던 회원의 정보는 복구할 수 없습니다.
기본 정보
POST
https://api.groobee.io/v2/users/sms?delete
API Key
요청 헤더
x-api-key
x-api-key: ${x-api-key}
O
Content-Type
Content-Type: application/json
O
쿼리 파라미터
delete
-
삭제 명령 파라미터
O
파라미터 값(value)이 없어도 동작
요청 본문
appUserId
String
삭제할 회원의 앱 유저 아이디
O
응답
회원정보 '삭제' 응답은 성공/실패 시 모두 정상 응답하며 입력받은 회원 정보의 오류가 있으면 정상 데이터는 처리하고 오류데이터 행을 오류코드와 함께 반환합니다.
appUserId
String
삭제할 회원의 앱 유저 아이디
failureCode
String
입력한 행의 실패 코드
"F06" : 앱 유저 아이디가 빈 값
예제
요청
응답(성공)
응답(실패)
데이터 오류가 있을 경우 실패 응답에 실패한 데이터 및 오류코드를 함께 응답합니다.
공통 사항
processCode 코드값
0
성공
-
-1000
실패
요청 시 Header에 x-api-key 미존재
-1001
실패
고객사 미존재
-1002
실패
고객사 미승인 상태 (승인 필요)
-1003
실패
고객사 계약기간 만료
-1004
실패
데이터 초과
-9997
실패
데이터가 올바르지 않습니다.
-9998
실패
http 관련 에러
-9999
실패
요청 API 서버 에러
-1005
실패
진행 중인 프로세스 있음
-1006
실패
회원 ID가 올바르지 않습니다.
-1013
실패
회원 이름 길이 초과(20자 이하)
-1014
실패
회원 앱 유저 아이디가 올바르지 않습니다.
Last updated