> For the complete documentation index, see [llms.txt](https://onestore-dev.gitbook.io/dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://onestore-dev.gitbook.io/dev/tools/app-links/reference.md).

# 레퍼런스

### **용어정리** <a href="#id" id="id"></a>

| 필수 용어 | 설명                                                        | 비고          |
| ----- | --------------------------------------------------------- | ----------- |
| PID   | Product ID의 줄임말로, Application 등록 시 자동으로 발급되는 고유한 ID 값입니다. | AID와 혼동 유의. |

### **지원 클라이언트 버전** <a href="#id" id="id"></a>

대한민국

| 스토어 버전  | 비고      | 패키지네임                   | 지원버전                                           |
| ------- | ------- | ----------------------- | ---------------------------------------------- |
| T store | -       | com.skt.skaf.A000Z00040 | Version Name = 5.0.0 / Version Code = 50000 이상 |
| olleh마켓 | 프리로드 버전 | com.kt.olleh.storefront | Version Name = 5.0.0 / Version Code = 50000 이상 |
| U+스토어   | LTE 단말  | com.lguplus.appstore    | Version Name = 5.0.0 / Version Code = 50000 이상 |

대한민국 외 다른 국가

| 스토어 버전 | 비고 | 패키지네임                         | 지원버전                                            |
| ------ | -- | ----------------------------- | ----------------------------------------------- |
| 싱가폴/대만 | -  | com.onestorecorp.gaa.storeapp | 모든 버전 지원                                        |
| 미국     | -  | com.dti.folderlauncher        | Version Name = 4.0.0 / Version Code = 400000 이상 |

### **URL scheme 연동 Reference** <a href="#id-urlscheme-reference" id="id-urlscheme-reference"></a>

* #### 상품 상세뷰 Reference <a href="#id-reference" id="id-reference"></a>

  명령어

  ```
  onestore://common/product/{product id}
  ```

  | Parameter  | Type   | Mandatory | Limit  | sample       | Description   |
  | ---------- | ------ | --------- | ------ | ------------ | ------------- |
  | product id | String | M         | 숫자 10자 | `0000252337` | 상품의 PID (숫자형) |
* #### 상품 검색뷰 Reference <a href="#id-reference" id="id-reference"></a>

  명령어

  ```
  onestore://common/search/{검색어}
  ```

  | Parameter | Type   | Mandatory | Limit   | sample | Description |
  | --------- | ------ | --------- | ------- | ------ | ----------- |
  | 검색어       | String | M         | 20 byte | `네이버앱` | 검색어 입력      |
* #### 업데이트 요청 <a href="#id" id="id"></a>

  명령어

  ```
  onestore://common/product/bg_update/{product id}
  ```

  | Parameter  | Type   | Mandatory | Limit  | sample       | Description   |
  | ---------- | ------ | --------- | ------ | ------------ | ------------- |
  | product id | String | M         | 숫자 10자 | `0000252337` | 상품의 PID (숫자형) |
* * **업데이트 요청 규격 참고사항**
    * 업데이트는 Background에서 진행되고 Noti를 통해 진행사항을 보여준다.
    * 최신버전이 이미 설치된 경우 요청을 무시한다.
    * 회원 기반 동작이므로 이용자가 원스토어 회원인 경우에 동작한다.
    * 회원이 아니거나 로그인에 실패한 경우 인증을 위한 로그인 화면이 자동 실행된다.
    * 유료앱은 구매이력이 이미 있는 경우에 동작한다.\ <br>

**Server side API**

* #### packageName 으로 PID 및 버전명 확인하기 <a href="#id-packagename-pid" id="id-packagename-pid"></a>

  command

  ```
  https://oneapi.onestore.net/api/devcenter/getAppVersion/v1?pkgNm={패키지네임}&deviceModelCd={모델명}&osVer={OS버전}&sdkVersion={SDK버전}
  ```

  **Request Parameters**

  | Parameter     | Type   | Mandatory | Limit | sample                   | Description          |
  | ------------- | ------ | --------- | ----- | ------------------------ | -------------------- |
  | pkgNm         | String | M         | `100` | `com.nhn.android.search` | App의 Package name    |
  | deviceModelCd | String | O         | `100` | `SM-N920S`               | 단말의 모델명              |
  | osVer         | String | O         | 5     | `6.0.1`                  | 단말의 OS버전             |
  | sdkVersion    | String | O         | 5     | 30                       | 단말 OS별 sdkVersion 정보 |

{% hint style="info" %}
deviceModelCd를 입력한 경우 osVer도 반드시 입력해주세요.
{% endhint %}

*

```
**Response Parameters**
```

````
<table><thead><tr><th width="118">Name</th><th width="121">Mandatory</th><th width="93">Type</th><th width="136">Description</th><th></th></tr></thead><tbody><tr><td>result</td><td><br></td><td>M</td><td><strong>Object</strong></td><td>응답 결과 정보</td></tr><tr><td><br></td><td>code</td><td>M</td><td>String</td><td><ul><li><p>응답 코드</p><ul><li>000 : success</li><li>100 : no data</li><li>200 : server error</li><li>400 : bad request</li><li>509 : server busy</li></ul></li></ul></td></tr><tr><td><br></td><td>desc</td><td>M</td><td>String</td><td>응답 메시지</td></tr><tr><td>prodId</td><td><br></td><td>M</td><td>String</td><td>상품ID</td></tr><tr><td>verNm</td><td><br></td><td>M</td><td>String</td><td>앱 버전</td></tr><tr><td>verCd</td><td><br></td><td>M</td><td>String</td><td>앱 버전 코드</td></tr><tr><td>longVerCd</td><td><br></td><td><br></td><td>String</td><td><ul><li><p>Version Code</p><ul><li><p>Android OS 버전이 Pie 이상이고 Major Version Code 등록된 경우 아래와 같이 응답</p><ul><li><p>Major Version Code와 versionCode 병합한 버전 코드</p><ul><li>(((long) major) &#x3C;&#x3C; 32) | (((long) minor) &#x26; 0xffffffffL)</li></ul></li></ul></li><li>그외는 "verCd"와 동일한 값이 응답 됨</li></ul></li></ul></td></tr><tr><td>title</td><td><br></td><td>M</td><td>String</td><td>상품명</td></tr><tr><td>topMenuId</td><td><br></td><td>M</td><td>String</td><td>Version Name, 디바이스 이름, OS버전을 등록해야만 나옴</td></tr><tr><td>topMenuNm</td><td><br></td><td>M</td><td>String</td><td>Version Code, 디바이스 이름, OS버전을 등록해야만 나옴</td></tr><tr><td>menuId</td><td><br></td><td>M</td><td><br></td><td>최상위 카테고리 코드</td></tr><tr><td>menuNm</td><td><br></td><td>M</td><td>String</td><td>최상위 카테고리 네임</td></tr><tr><td>sellerNm    </td><td><br></td><td>M</td><td>String</td><td>판매자 명</td></tr><tr><td>game</td><td><br></td><td>M</td><td>boolean</td><td><br></td></tr></tbody></table>

모델명을 넣지 않았을 떄, Response

```
{
    "result": {
        "code": "000",
        "desc": "success"
    },
    "prodId": "0000758646",
    "verNm": "1.36.120365",
    "verCd": "120365",
    "title": "블루 아카이브",
    "topMenuId": "DP01",
    "topMenuNm": "게임",
    "menuId": "DP01004",
    "menuNm": "롤플레잉",
    "sellerNm": "(주) 넥슨",
    "game": true
}
```

<br>

<br>
````

<br>