> For the complete documentation index, see [llms.txt](https://nsl-solution.gitbook.io/livesolution/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nsl-solution.gitbook.io/livesolution/developers/ready.md).

# 연동 준비하기

### 솔루션 연동 ID와 채널 이해하기 <a href="#id-channel" id="id-channel"></a>

쇼핑라이브 솔루션은 솔루션 연동 ID `externalServiceId`를 기반으로 제공됩니다. `externalServiceId`는 채널과 1:N의 관계를 가지는 서드파티 서비스의 고유 ID이며 다음과 같이 사용됩니다.&#x20;

* 서비스별 커스텀 요소 정의 (뷰어 노출 컴포넌트 및 동작을 id 단위로 분기)
* 시청 뷰어에 대한 접근 권한 정의 (해당 id에 맵핑된 방송만 접근 가능)
* 쇼핑라이브 REST API 호출시 헤더 인증 값으로 사용
* 전시 모듈 초기화시 설정하여, 해당 ID에 맵핑된 방송을 노출

즉, 1개 이상의 채널을 `externalServiceId`에 맵핑하여 해당 채널의 라이브를 서드 파티 서비스에 연동할 수 있습니다. 이 때 연동할 채널은 네이버 스마트스토어/브랜드스토어/윈도 채널로 한정되며, 해당 채널이 없는 경우 연동이 불가합니다.

### 솔루션 연동 ID와 KEY 발급 <a href="#id-key" id="id-key"></a>

쇼핑라이브 솔루션 API에 접근하기 위해서는 `externalServiceId`와 이에 대한 서비스키를 발급받아야 합니다. 쇼핑라이브 솔루션 연동을 통해 발급받을 수 있으며, 쇼핑라이브 관리툴에서 [라이브솔루션 연동](/livesolution/welcome/interlock.md#undefined)을 진행해주세요.&#x20;

### 콜백 URL 등록 <a href="#callback" id="callback"></a>

라이브 생성/라이브 시작/라이브 종료/업데이트/삭제 등 방송 status 및 data 변경이 일어날시 솔루션을 사용하시는 파트너사 측에서 필요한 기능을 구현하실 수 있도록 콜백 이벤트를 전달합니다. 해당 이벤트 수신을 원하시는 경우 제공받을 콜백 API URL을 등록합니다. (개발용 / 운영용)

* [개발용 엔드포인트](#user-content-fn-1)[^1]는 쇼핑라이브 TEST 타입 라이브에서 발생하는 이벤트를 전달&#x20;
* 운영용 엔드포인트는 쇼핑라이브 REAL 타입 라이브에서 발생하는 이벤트를 전달&#x20;
* 발급된 externalServiceId / KEY 를 헤더에 싣어서 payload 와 함께 호출&#x20;
* 이벤트를 수신 후 방송 데이터를 갱신하기 위해서는 방송 단건 no-cache API를 호출해야합니다.

{% code title="RESPONSE SCHEMA" %}

```php
curl --location --request POST 'localhost:8080/v1/example/callback' \
--header 'X-EXTERNAL-SERVICE-ID: yourservice' \

--header 'X-EXTERNAL-SERVICE-KEY: ZojfvlreYtRrS4h4xxgEBgEgYj4dMo' \
--header 'Content-Type: application/json' \
--data-raw '{
"broadcastId": -1,
"action": "UPDATE"
}'
```

{% endcode %}

### 서비스 로고 등록  <a href="#logo" id="logo"></a>

쇼핑라이브 뷰어 내 노출되는 서비스로고의 등록이 필요합니다. 서비스 로고는 아래 가이드를 충족해야합니다.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>PSD 가이드</strong></td><td>포토샵 파일로 가이드를 다운로드합니다.</td><td><a href="https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.psd">https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.psd</a></td><td><a href="https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.psd">https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.psd</a></td></tr><tr><td><strong>FIGMA 가이드</strong></td><td>피그마 파일로 가이드를 다운로드합니다.</td><td><a href="https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.fig">https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.fig</a></td><td><a href="https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.fig">https://im.pstatic.net/selective/etc/livesolution_logo_create_guide.fig</a></td></tr></tbody></table>

<figure><img src="/files/Vg6llKgtoAu6jVRImkqE" alt=""><figcaption></figcaption></figure>

[^1]: 개발용 엔드포인트의 경우, 네이버에서 접근이 가능한 환경으로 제공되어야합니다.