앱 (App)
Gency API 센터에서 앱을 만들고 Client ID·Client Secret, Redirect URI, OAuth 스코프, API Key를 발급·관리하는 방법을 안내합니다.
Gency API 센터에서 자신만의 앱을 생성하고 관리할 수 있습니다.
기본 정보
앱을 생성하면 다음 정보를 설정할 수 있습니다.
- 앱 아이콘 & 이름: 이 아이콘과 이름은 다음 상황에서 표시됩니다:
- OAuth 인가 동의 화면
- Bot 사용자 프로필 (
Bot: {앱 이름})
- 설명 (최대 500자): 앱의 용도와 기능을 설명합니다.
인증 정보
앱 생성 시 다음 인증 정보가 자동으로 발급됩니다.
- Client ID:
gency_client_{랜덤문자열}형식으로 발급됩니다. OAuth 흐름에서 앱을 식별하는 데 사용됩니다. - Client Secret:
gency_secret_{랜덤문자열}형식으로 발급됩니다. Secret 재발급 버튼을 클릭하면 새로운 시크릿이 발급되며, 기존 시크릿은 즉시 무효화됩니다. - Redirect URIs: OAuth 인가 흐름에서 사용되는 리다이렉트 URL 목록입니다. 인가 요청 시 전달하는
redirect_uri는 반드시 여기 등록된 URI 중 하나와 일치해야 합니다.
스코프
앱에서 사용할 OAuth 스코프를 체크박스로 선택합니다. 인가 요청 시 여기 등록된 스코프만 전달할 수 있습니다.
| 스코프 | 설명 |
|---|---|
product:read | 상품 목록 조회 |
product:write | 상품 생성/수정/삭제 |
team:read | 팀 조회 |
team:write | 팀 수정/관리 |
user:read | 사용자 조회 |
API Key
OAuth 토큰 대신 간편하게 API를 호출할 수 있는 키입니다.
- API Key 를 활성화 하면 API Key를 이용할 수 있습니다.
- 활성화 시 Bot 사용자가 자동 생성되어 팀 멤버로 등록됩니다.
- API 호출 시
X-API-Key헤더에 키를 전달하여 인증합니다. - 토글 스위치로 활성화/비활성화할 수 있습니다.