연동 방식
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 값>'
응답 결과
JSON으로 응답하며 형태는 아래를 참고해 주세요.
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": <요청한 엔드포인트의 응답값>
}
processCode 코드값
| 코드 값 |
상태 |
설명 |
| 0 |
성공 |
- |
| -1000 |
실패 |
요청 시 Header에 x-api-key 미존재 |
| -1001 |
실패 |
고객사 미존재 |
| -1002 |
실패 |
고객사 미승인 상태 (승인 필요) |
| -1003 |
실패 |
고객사 계약기간 만료 |
| -1004 |
실패 |
데이터 초과 |
| -9997 |
실패 |
데이터가 올바르지 않습니다. |
| -9998 |
실패 |
http 관련 에러 |
| -9999 |
실패 |
요청 API 서버 에러 |
엔드 포인트
회원 공통
processCode 코드값
| 코드 값 |
상태 |
설명 |
| -1005 |
실패 |
진행 중인 프로세스 있음 |
| -1006 |
실패 |
회원 ID가 올바르지 않습니다. |
| -1007 |
실패 |
회원 전화번호가 올바르지 않습니다. |
SMS 회원
SMS 회원정보 조회
SMS 특정 회원정보를 조회하는 API
요청 형태
| Method |
URI |
요청/응답 형식 |
| GET |
/v1/users/sms |
JSON |
매개 변수 쿼리 스트링으로 조회하며 아래 파라미터에서 1개 이상이 필수
| Parameter Name |
Description |
| memberId |
조회 회원 아이디 |
| phoneNumber |
조회 회원 전화번호 |
응답 데이터{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": [
{
"memberId":<검색된 회원 아이디>,
"phoneNumber": <검색된 회원 전화번호 (저장된 형식과 무관하게 000-0000-0000 와 같이 하이픈이 있는 형식)>,
"isReceive":<검색된 회원 수신 동의여부(true|false)>
}
]
}
SMS 회원정보 저장/수정
한 회원에 여러 전화번호가 있을 경우 요청한 번호로 모두 변경됩니다.
요청 형태
| Method |
URI |
요청/응답 형식 |
| POST |
/v1/users/sms |
JSON |
매개 변수
| Parameter |
Parameter Name |
Description |
| users (max 1000) |
memberId |
회원 아이디 |
|
phoneNumber |
회원 전화번호 |
|
isReceive (Y = true, N=false) |
회원 수신 동의여부 |
요청 데이터 등록할 회원 정보들을 배열로 요청 한다.[
{
"memberId":<회원 아이디>,
"phoneNumber":<회원 전화번호>,
"isReceive":<회원 수신 동의여부>
}
...
]
응답 데이터 성공 여부와 상관없이 processValue 키에 해당 되는 값은 없다.{
"httpStatus": {
"col": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": ""
}
SMS 회원정보 삭제
요청 형태
| Method |
URI |
요청/응답 형식 |
| DELETE |
/v1/users/sms |
JSON |
매개 변수
| Parameter |
Parameter Name |
Description |
| users (max 1000) |
memberId |
회원 아이디 |
요청 데이터
등록할 회원 아이디들을 배열로 요청한다.
[
<회원 아이디>, ...
]
응답 데이터
성공 여부와 상관없이 processValue 키에 해당 되는 값은 없다.
{
"httpStatus": {
"code": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": ""
}
전체 회원정보 삭제
API를 통해 수집된 회원 정보와 WEB/APP을 통해 수집된 전체 회원정보를 삭제합니다.
요청 형태
| Method |
URI |
요청/응답 형식 |
| DELETE |
/v1/users |
JSON |
매개 변수
| Parameter |
Parameter Name |
Description |
| users (max 1000) |
memberId |
회원 아이디 |
요청 데이터 삭제할 회원 아이디들을 배열로 요청 한다.[
<회원 아이디>, ...
]
응답 데이터 성공 여부와 상관없이 processValue 키에 해당 되는 값은 없다.{
"httpStatus": {
"col": <http status code>,
"reasonPhrase": <http status 내용>
},
"processCode": <성공여부>,
"processValue": ""
}
Updated
by
Editor
