회원
1. 개요
REST API를 이용한 오프사이트 캠페인의 발송 대상의 회원 정보를 그루비에 전송하는 API 입니다.
2. 주요 기능
회원 API를 통해 그루비에 회원 ID, 전화번호, 수신 동의 여부, 회원 이름 등의 회원 정보를 그루비로 전송합니다.
전송된 회원 정보는 그루비 오프사이트 캠페인 메시지 발송 시의 데이터로 사용됩니다.
데이터 중 회원 ID와 전화번호는 필수이며, 수신 동의 여부와 회원 이름은 선택 사항으로 보낼 수 있는 데이터입니다.
단, SMS 발송을 사용할 예정이라면 수신 동의 여부를 필수로 전송하여야 합니다.
※ 수신 동의 여부는 요청 값이 없을 시 기본 '동의하지 않음(false)'으로 저장됩니다.
3. 회원 API : v1 과 v2
회원 API v1, v2 모두 요청, 응답 데이터는 동일합니다.
두 방식의 차이점은 key 값의 차이입니다.
key
회원 ID(memberId)
전화번호(phoneNumber)
설명
회원 ID가 유니크한 값 입니다. 회원 ID는 중복될 수 없으며, 전화번호는 중복 값을 가질 수도 있습니다.
전화번호가 유니크한 값 입니다. 전화번호는 중복될 수 없으며, 회원 ID는 중복 값을 가질 수도 있습니다.
4. 사용 예시
우리 사이트는 한 회원 당 전화번호는 하나만 가지고 있어야 합니다. → 회원 API v1 사용
만약 이미 저장된 회원 ID에 저장된 번호와 다른 전화번호를 저장 요청한다면, 해당 회원 ID에 새로운 전화번호로 업데이트됩니다.
우리 사이트는 한 회원이 다수의 전화번호를 가질 수 있는 구조입니다. → 회원 API v2 사용
만약 이미 저장된 회원 ID와 동일한 회원 ID에 중복되지 않는 새로운 전화번호를 저장 요청한다면, 회원 ID와 전화번호가 추가되어 한 회원이 2개 이상의 전화번호를 가질 수 있습니다.
5. 주의 사항
• 회원 API v1, v2 버전을 혼용하여 사용할 시 데이터가 혼재될 수 있습니다. 두 버전을 혼용해서 사용하지 말아주세요.
• 캠페인 중 SMS 캠페인 메시지를 발송하기 위해서는 수신 동의 여부를 필수로 전송해야 합니다.
• 회원 이름은 정보를 전송하지 않으면 정보가 없는 상태로 응답합니다.
Last updated