숏폼을 초기화할 때 로그인한 사용자의 아이디와 이름을 직접 입력하는 방식입니다. 고객사 서버에서 JWT를 적용하기 어렵거나, 숏폼을 빠르게 연동하고 싶은 경우 이용합니다. 숏폼 자체는 userId, userName 두 필드만 사용합니다.
간편 인증은 빠르고 간편하지만, 어뷰징이 우려되는 경우 보안이 강화된 JWT 인증 사용을 권장합니다.
userObject는 라이브 플러그인과 숏폼이 공통으로 사용하는 사용자 인증 객체입니다. 이 중 gender, age, custom, userScore, userType, profile 필드는 라이브에서만 사용되며 숏폼에서는 사용되지 않습니다. 다만 같은 페이지에서 두 SDK를 함께 사용하는 경우, 나중에 호출되는 쪽이 이전 인증 정보를 완전히 대체하므로 이 필드들도 함께 전달하지 않으면 라이브 쪽 정보가 유실될 수 있습니다.
Property name | Description | Sample | Comment |
|---|
userId (필수) | 사용자 아이디 | sample_user_id | 로그인 사용자의 유일성을 보장할 수 있는 값. 값이 없으면 별도 안내 없이 로그인 상태가 적용되지 않습니다. |
userName | 사용자 이름 (댓글에서 사용) | 닉네임 | 댓글 작성 시 표시되는 이름입니다. |
gender | 사용자 성별 | 빈 값(미지정), m(남), f(여) | 라이브에서만 사용 |
age | 사용자 나이 | 25 | 라이브에서만 사용 |
custom | 사용자 임의 데이터 | custom data | 최대 1KB까지 설정 가능. 라이브에서만 사용 |
userScore | 사용자 등급 | 10 | -100~100 정수. 라이브에서만 사용 |
userType | 사용자 유형 | VIP | 라이브에서만 사용 |
profile | 사용자 프로필 이미지 URL | https://image.shoplive.cloud/sample_profile.png | 권장 이미지 크기 64x64px. 라이브에서만 사용 |
아래의 샘플 코드를 참고하시기 바랍니다.
<script type="text/javascript" src="https://static.shoplive.cloud/shoplive-shortform.js"></script>
<script>
const userObject = {
userId: "{userID_here}", // required
userName: "{userName_here}", // optional
// 아래는 숏폼 자체에서는 사용하지 않는 필드입니다.
// 같은 페이지에서 라이브 플러그인도 함께 사용하는 경우에만 포함해 주세요.
gender: "m", // optional
age: 25, // optional
custom: "custom data", // optional
userScore: 10, // optional
userType: "VIP", // optional
profile: "https://image.shoplive.cloud/sample_profile.png" // optional
};
// initShortform과 함께 전달하는 방식
cloud.shoplive.initShortform({
accessKey: 'YOUR ACCESS KEY HERE',
userObject: userObject
});
</script>
<!-- OR -->
<script type="text/javascript" src="https://static.shoplive.cloud/shoplive-shortform.js"></script>
<script>
const userObject = {
userId: "{userID_here}", // required
userName: "{userName_here}", // optional
// 아래는 숏폼 자체에서는 사용하지 않는 필드입니다.
// 같은 페이지에서 라이브 플러그인도 함께 사용하는 경우에만 포함해 주세요.
gender: "m", // optional
age: 25, // optional
custom: "custom data", // optional
userScore: 10, // optional
userType: "VIP", // optional
profile: "https://image.shoplive.cloud/sample_profile.png" // optional
};
cloud.shoplive.initShortform({ accessKey: 'YOUR ACCESS KEY HERE' });
// setUserObject()를 통해 전달하는 방식
cloud.shoplive.setUserObject(userObject);
</script>
.png){kind=logo}
