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

# 참고사항

치지직 개발자 센터 및 Open API 이용 시 알아야 할 규격을 설명합니다.

\*최근 90일간 API Scope 사용량이 0인 애플리케이션은 삭제됩니다.

## 애플리케이션 ID 및 이름

애플리케이션 등록 시 ID 및 이름에 'chzzk', '치지직', 'naver', 네이버' 등 공식 서비스명이 포함될 수 없습니다. 또한, 부적절한 단어가 포함될 경우 애플리케이션이 정지될 수 있으니 유의해 주세요.

## Open API 도메인

```
https://openapi.chzzk.naver.com
```

## API 호출

특정 API Scope를 호출하려면 Access Token 또는 Client 인증이 필요합니다. Access Token 인증이 필요한 API Scope 호출 시 Authorization 헤더에 Bearer와 함께 Access Token을 지정해야 합니다.

{% hint style="warning" %}
**주의사항**\
Access Token 인증 API 사용 시 Bearer를 반드시 명시해야 하며, Bearer와 Access Token 사이에 공백( )을 빠뜨리지 않도록 주의해야 합니다.
{% endhint %}

### Access Token 인증 API

**Request Header**

<table><thead><tr><th width="148">Key</th><th width="96">Type</th><th>Example</th></tr></thead><tbody><tr><td>Authorization</td><td>String</td><td>Bearer FFok65zQFQVcFvH2eJ7SS7SBFlTXt0EZ10L5XXXXXXXX</td></tr><tr><td>Content-Type</td><td>String</td><td>application/json</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>

### Client 인증 API

**Request Header**

<table><thead><tr><th width="152">Key</th><th width="93">Type</th><th>Example</th></tr></thead><tbody><tr><td>Client-Id</td><td>String</td><td>fefb6bbb-00c2-497c-afc2-XXXXXXXXXXXX</td></tr><tr><td>Client-Secret</td><td>String</td><td>VeIMuc9XGle7PSxIVYNwPpI2OEk_9gXoW_XXXXXXXXX</td></tr><tr><td>Content-Type</td><td>String</td><td>application/json</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>

## API 공통 응답 구조

**성공 시**&#x20;

```
{
    "code": 200,
    "message": null,
    "content": {responseBody}
}
```

**실패 시**

```
{
    "code": "integer",
    "message": "string"
}
```

## Error Code

<table><thead><tr><th width="153">HTTP Code</th><th width="254">Error Message</th><th>Description</th></tr></thead><tbody><tr><td>400</td><td>잘못된 값을 입력했습니다.</td><td>요청 파라미터 에러</td></tr><tr><td>401</td><td>UNAUTHORIZED</td><td>필요 인증 정보 없음</td></tr><tr><td>401</td><td>INVALID_CLIENT</td><td>Client 정보 비정상</td></tr><tr><td>401</td><td>INVALID_TOKEN</td><td>존재하지 않는 token, 기한 만료<br>( Access Token, Refresh_token)<br>- 만료된 Access Token<br>- 만료된 Refresh Token<br>- Delete 요청 된 Access Token<br>- 존재하지 않는 Token</td></tr><tr><td>403</td><td>FORBIDDEN</td><td>호출 권한 없음</td></tr><tr><td>404</td><td>NOT_FOUND</td><td>검색 결과 없음</td></tr><tr><td>429</td><td>TOO_MANY_REQUESTS</td><td>Quota 제한 초과</td></tr><tr><td>500</td><td>INTERNAL_SERVER_ERROR</td><td>서버 내부 에러</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>