Shoplive 도메인(shoplive.show)을 활용한 플레이어 사용 가이드

이 페이지에서는 Shoplive에서 제공하는 shoplive.show 도메인 기반의 Player를 고객사의 웹사이트 또는 모바일 어플리케이션(Webview)에 연동하기 위한 가이드를 제공합니다.

Shoplive의 Player는 아래와 같은 방식으로 고객사의 웹페이지에서 사용할 수 있습니다.

• Shoplive Javascript SDK를 활용한 Player 설치
• Shoplive Plugin을 활용한 Player 설치
• shoplive.show 도메인에서 제공하는 Player 호출

Javascript SDK를 통한 설치와 Plugin을 통한 설치는 고객사에서 서비스하는 랜딩 페이지가 있어야만 Player를 설치할 수 있는데 반해, shoplive.show에서 제공하는 Player는 고객사에 별도의 랜딩 페이지가 없더라도 간단한 URL 호출만으로도 Player를 실행할 수 있는 장점이 있습니다.

shoplive.show에서 제공하는 Player를 호출하기 위해서는 아래의 URL과 파라미터를 참고하시기 바랍니다.

Player URL

https://www.shoplive.show/v1/player.html

URL parameter

• ak 고객사의 access key 정보 (필수)
• ck Player에서 재생할 campaign key 정보 (필수)
• tk 일반 인증 또는 JWT 토큰 형태의 인증 정보 (게스트 사용자의 경우 tk 파라미터를 전달하지 않아도 됩니다.)
• backButton 1(표시) | 0(표시하지 않음)
• shareButton 1(표시) | 0(표시하지 않음)
  
  

인증 정보의 설정(tk 파라미터)

일반 인증

• 일반 인증에 대한 안내
• JSON 객체로 userId, userName 등의 정보를 설정한 후 tk 파라미터로 Player를 호출할 때 반드시 url encode하여 전달하여야 합니다.
• JSON 객체의 예: {"userId": "userID", "userName":"userName"}
• tk 파라미터에서 사용할 url encode된 JSON 객체의 예:
  %7B%22userId%22%3A%20%22userID%22%2C%20%22userName%22%3A%22userName%22%7D
• url encode가 두 번 되지 않도록 주의하세요!

JWT 인증

• 고객사 서버에서 secret key로 암호화하여 JWT를 생성한 후 (JWT 생성 안내)
• 생성된 토큰을 tk 파라미터로 전달합니다.

예제

• https://www.shoplive.show/v1/player.html?ak={access_key}&tk={JWT_token}&ck={campaign_key}

Guest 사용자를 위한 Player를 호출하는 예 (tk 파라미터를 전달하지 않음)

• https://www.shoplive.show/v1/player.html?ak=Lm9LJaufCztZXJ5gpNg2&ck=1c042f398773&backButton=1

일반 인증 정보를 포함하여 Player를 호출하는 예

• https://www.shoplive.show/v1/player.html?ak=Lm9LJaufCztZXJ5gpNg2&ck=1c042f398773&tk=%7B%22userId%22%3A%20%22userID%22%2C%20%22userName%22%3A%22userName%22%7D&backButton=1

JWT 토큰을 포함하여 Player를 호출하는 예

• https://www.shoplive.show/v1/player.html?ak=Lm9LJaufCztZXJ5gpNg2&ck=1c042f398773&tk={JWT_TOKEN}&backButton=1

다시보기를 위한 플레이어 호출 방법

Shoplive Player는 라이브와 동일한 URL과 파라미터를 활용하여 이미 진행한 캠페인의 다시보기를 서비스할 수 있습니다. 단, Shoplive 어드민의 캠페인 상세 설정에서 다시보기 옵션을 on으로 설정하셔야 하는 점을 꼭 체크해 주시기 바랍니다.