고객 가이드

​

계정 상태

고객의 계정 상태는 정상 상태인 경우 NORMAL로 표시되고, 휴면 정책에 따라 휴면 고객의 상태는 DORMANT로 표시됩니다.
고객 계정이 휴면 상태로 전환되기 위한 기본 조건은 활성 구독이 없어야 합니다. 만약 고객이 최근 11개월 동안 주문이나 로그인을 하지 않았다면, 휴면 계정 전환 예정에 대한 알림을 고객의 이메일로 발송합니다. 만약 고객이 12개월 동안 주문이나 로그인을 하지 않는 경우, 고객 계정은 휴면 상태로 전환되며, 이에 대한 알림을 고객의 이메일로 보내게 됩니다.

상태	명칭
NORMAL	정상
DORMANT	휴면

​

연관 가이드

• 인증 가이드
• 주문 가이드
• 구독 가이드

​

사전 준비 작업

• Secret-Token 확인하기

​

API 사용 예시

​

고객 생성

• Request
  Copy

  curl --request POST \
       --url https://api.steppay.kr/api/v1/customers \
       --header 'Secret-Token: b9412897585074d04d11cc2384f2a50425aa8cb0f78bd23ee3e3d4cb65a1e55c' \
       --header 'accept: */*' \
       --header 'content-type: application/json' \
       --data '
  {
    "name": "STEPPAY",
    "email": "test@steppay.kr"
  }
  
• Response
  Copy

  {
    "id": 242443,
    "name": "STEPPAY",
    "email": "test@steppay.kr",
    "phone": null,
    "code": "customer_75zcznodv",
    "marketingSms": false,
    "marketingEmail": false,
    "marketingKakao": false,
    "createdAt": "2023-06-19T02:34:15.399478"
  }
  

​

커스텀 필드를 포함한 고객 생성

커스텀 필드를 사용하려면 먼저 커스텀 필드 설정을 해야합니다.
설정attributes에 커스텀 필드에 대한 정보 입력하고, key-value 형식으로 입력합니다. 여기서 key에 설정된 커스텀 필드의 키 값이며, value는 JSON 형식으로 입력해야 합니다.

• Request
  Copy

  curl --request POST \
       --url https://api.steppay.kr/api/v1/customers \
       --header 'Secret-Token: b9412897585074d04d11cc2384f2a50425aa8cb0f78bd23ee3e3d4cb65a1e55c' \
       --header 'accept: */*' \
       --header 'content-type: application/json' \
       --data '
  {
    "name": "STEPPAY",
    "email": "test@steppay.kr"
    ...
    "attributes": {
  	  "bfl9no1mg3w": "\"demo text\""
  }
  

​

스텝페이 포탈 사용 예시

스텝페이 포탈에서 고객을 생성하는 방법은 간단합니다.

1. [고객 관리 → 새 고객 추가] 메뉴로 이동합니다.
2. 아래와 같이 필수 필드에 값을 채우고 추가 버튼 클릭합니다.

   필수 필드 외 커스텀 필드에 대한 설정은 아래 커스텀 필드 설정에서 확인할 수 있습니다.

​

연동 가이드

​

고객 연동 방법

• 가맹점에 기존 고객이 없는 경우
  • 가맹점의 고객이 추가될때, 스텝페이 고객도 추가되어야 합니다.
  • 즉, 가맹점의 고객과 스텝페이의 고객 정보가 동기화 되어야 합니다.
• 가맹점에 기존 고객이 있는 경우
  • 가맹점에 기존 고객의 정보를 스텝페이 고객에 추가해야 합니다.
  • 기존 고객 정보를 스텝페이에 추가하기 위해 엑셀 업로드 또는 고객 등록 API를 반복 호출하여 추가할 수 있습니다.

​

고객 엑셀 업로드 기능

1. [고객 관리 → 전체 고객 내역] 메뉴로 이동합니다.
2. 고객 대량 업로드 버튼 클릭합니다.
3. 아래와 같이 고객 정보에 대한 엑셀 파일을 업로드하여 고객을 추가합니다.

​

커스텀 필드 설정 방법

스텝페이에서는 고객을 생성할 때 다양한 형태로 저장할 수 있도록 빌더를 제공합니다.
기본적인 회원 가입 필드(아이디, 이름, 휴대폰 번호, 이메일, 비밀번호, 마케팅 수신 동의)의 필드명을 변경하거나 활성화/비활성화 할 수 있고, 필수 입력 여부 설정을 통해 고객 데이터의 기본 구조를 자유롭게 설정할 수 있습니다.
또한, 고객의 추가 정보를 수집하고 저장하기 위해 커스텀 필드를 제공하며, 이 필드들은 필요에 따라 언제든지 추가, 수정, 또는 삭제가 가능합니다.
추가할 수 있는 커스텀 필드 타입은 아래와 같습니다. 커스텀 필드 설정 방법은 아래와 같습니다.

1. [마이스토어 설정 → 가입/로그인 설정 → 회원가입] 메뉴로 이동합니다.
2. 아래와 같이 커스텀 필드들을 자유롭게 설정합니다.
3. 추가한 커스텀 필드에 대한 key 값을 복사하여 고객 생성 API 사용 시 해당 key 값을 커스텀 필드에 추가합니다.
4. 새로운 고객을 생성하면, 추가된 커스텀 키 값을 확인할 수 있습니다.

​

소셜 로그인 설정

1. 카카오/네이버 애플리케이션을 생성합니다.
   • 애플리케이션 키 값을 확인합니다.
   • 필수동의 사항을 아래에서 확인 후 동일하게 체크합니다.
   • 화면의 Redirect URL 값을 복사하여 애플리케이션 RedirectUrl(CallbackUrl)에 등록합니다.
2. [마이스토어 설정 → 가입/로그인 설정 → 소셜 로그인] 메뉴로 이동합니다.
3. 카카오/네이버 소셜 로그인을 설정합니다.
   • 카카오 소셜 로그인을 위해 REST API 키를 입력합니다.
   • 네이버 소셜 로그인을 위해 클라이언트 ID와 클라이언트 시크릿을 입력합니다.

​

소셜 로그인 필수동의 사항

• 카카오 로그인 필수동의 사항
• 네이버 로그인 필수동의 사항