API 토큰 관리

Overview

QueryPie는 관리자가 활용 가능한 External API를 제공합니다. 제공하고 있는 API 목록 및 명세 확인은 Settings > General Settings > System > API Token 우측 상단의 API Docs를 통해 조회 가능합니다.

• QueryPie API V2는 쿼리파이 버전 9.16.1에서부터 지원하며, 베이스가 되는 경로는 {querypie url}/api/external/v2/로 기존의 API V0.9에 영향 없이 이용 가능합니다. 호출을 위해 이용 중이신 쿼리파이 앱에 설정하신 도메인을 기입하여 호출하여 주시기 바랍니다.

• API 호출 시 필요한 기본 헤더는 이하와 같습니다:

• API 토큰은 Owner 권한 사용자 또는 해당 메뉴 접근 권한이 있는 관리자가 발급할 수 있으며, Create API Token 버튼을 클릭하여 생성할 수 있습니다.

• 한번 발급된 토큰에 대하여 노출은 한 회만 제공되며, 이후 내역에서는 앞의 8자리를 제외한 나머지는 모두 마스킹하여 표시됩니다.

• 토큰 키를 분실한 경우, 기존 키를 내역에서 삭제하고 토큰을 새로 발급 받아 사용하실 것을 권장합니다.

• API 토큰 수명이 임박하여 연장을 원하는 경우, 우측의 Update를 눌러 누른 시점으로부터 설정된 기한 주기만큼 연장이 가능합니다.

API 토큰 생성하기

1. General Settings 메뉴에서 System > API Token 메뉴로 이동합니다.

2. 우측 상단의 Create API Token 버튼을 클릭합니다.

3. 토큰 생성을 위한 다음의 정보들을 입력합니다.

   1. API Name : 식별 가능한 API 토큰의 이름을 기입합니다.

   2. Validity Period Type : 토큰의 만료 기한을 지정합니다.

      1. Never Expire 선택시 토큰을 영구적으로 사용할 수 있으나 권장하지 않습니다.

   3. Scopes : API 토큰으로 수행할 수 있는 권한을 선택합니다.

      1. Full Access : 관리자 기능 전체를 수행할 수 있는 권한입니다.

      2. Select Role : Admin Role 을 선택하여 해당 토큰으로 수행할 수 있는 작업 범위를 제한할 수 있습니다.

   4. Description : 해당 API 토큰에 대한 설명을 작성합니다.

4. Ok 버튼을 통해 토큰 생성을 완료하면, API Token 정보를 1회에 한해 확인할 수 있습니다.

5. 활용할 스크립트, 툴 등에 발급된 토큰을 복사하여 저장한 뒤, OK 버튼을 눌러 생성을 마무리합니다.

토큰 만료일 변경/연장하기

• API Token 메뉴 리스트에서 대상 토큰 맨 우측 컬럼의 Update 버튼을 눌러 Validity Period Type 에 설정된 기간만큼 기한을 연장할 수 있습니다.

• 또는 API 토큰을 클릭하여 Edit API Token 화면에서 Validity Period Type을 변경하고 OK 버튼을 눌러 현재 시점에서 새로 지정한 기한까지 새로 연장할 수 있습니다.

토큰 권한 변경하기

• Edit API Token 화면의 Scopes 항목에서 Admin Role 을 추가/제거하여 해당 API 토큰으로 수행할 수 있는 관리자 권한을 변경할 수 있습니다.

• API 토큰 권한에 할당된 Admin Role 이 모두 삭제되는 경우, 해당 토큰은 아무런 권한을 가지지 않게 됩니다.

관련 토픽

• 계정 잠금 정책 및 타임아웃 설정

Back to 인증 및 보안 설정