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 호출 시 필요한 기본 헤더는 이하와 같습니다:
Key | Value |
---|---|
Content-Type | application/json |
Authorization | {querypie api token} |
QueryPie의 API 토큰은 Owner 또는 Application Admin 권한의 관리자가 발급할 수 있으며, Settings > General Settings > System > API Token 경로에서
+ Create API Token
버튼을 클릭하여 생성할 수 있습니다.한번 발급된 토큰에 대하여 노출은 한 회만 제공되며, 이후 내역에서는 앞의 8자리를 제외한 나머지는 모두 마스킹하여 표시됩니다.
토큰 키를 분실한 경우, 기존 키를 내역에서 삭제시키고 토큰을 새로 발급 받아 사용하는 것을 권장합니다.
API 토큰 수명이 임박하여 연장을 원하는 경우, 우측의 Update를 눌러 누른 시점으로부터 설정된 기한 주기만큼 연장이 가능합니다.
API 토큰 생성하기
Settings > General Settings > System > API Token 메뉴에서
+Create API Token
을 클릭합니다.
이하의 정보를 기입한 뒤
OK
버튼을 눌러 토큰을 생성합니다.API Name : 쿼리파이 화면에서 식별 가능한 API 토큰 표기명을 기입합니다.
Validity Period Type : 토큰 기한을 지정합니다.
1 Day
7 Days
30 Days
90 Days
180 Days
360 Days
720 Days
Never Expire
Description : 해당 API 토큰에 대한 설명을 기입합니다.
활용할 스크립트, 툴 등에 발급된 토큰을 복사하여 저장한 뒤,
OK
버튼을 눌러 생성을 마무리합니다.
토큰 만료일 변경/연장하기
Settings > General Settings > System > API Token 메뉴에서 대상 토큰 맨 우측 컬럼의
Update
버튼을 눌러 기한을 연장할 수 있습니다.
또는 대상 토큰 행을 클릭하여 Edit API Token 창을 오픈한 뒤 Validity Period Type을 변경하고
OK
버튼을 눌러 현재 시점에서 새로 지정한 기한까지 새로 연장할 수 있습니다.
관련 토픽