Open API 사용하기
팔로우
Introduction
본 가이드는 디파이너리 내 저장된 데이터를 다운로드 / 업데이트 or 생성 할 수 있도록 개발된 Open API 가이드입니다.
[[인용:위험:보통]] Notice
디파이너리 Open API 사용을 위해선 유료 플랜 업그레이드가 필요합니다. (무료 플랜 미지원)
플랜에 따라 토큰 사용 가능여부가 달라집니다.
[ 제공 정책 ]
- '무료 플랜 -> 유료 플랜' 업그레이드 시 : 신규 토큰 발급 가능
- '유료 플랜 -> 무료 플랜' 다운그레이드 시 : 발급된 토큰 즉시 정지
- '무료 플랜 -> 유료 플랜' 재업그레이드 시 : 정지된 토큰 즉시 재활성화
Open API 사용하기
API Token 발급
Open API 를 사용하기 위해서는 디파이너리 콘솔을 통해 API Token 을 발급받아야 합니다. API Token 은 아래와 같이 급합니다.
- 디파이너리 콘솔을 로그인 후 좌측 메뉴에 Setting & SDK 메뉴에서 Application 을 선택합니다.
- 앱 리스트에서 Open API 를 사용할 앱을 확인하고 "관리" 버튼을 클릭합니다.
- 하단 메뉴에서 Token 메뉴를 클릭합니다.
- 생성된 Token 이 없으면 "+ 추가" 버튼을 클릭합니다.
- 생성된 토큰을 확인합니다.
[[인용:안내:보통]] 발급된 토큰이 삭제 혹은 재발행된 경우 기존 토큰은 최대 14일간 사용이 가능합니다.
Rate Limit
[[인용:안내:보통]] API Rate Limit 은 토큰 유형 별로 상이합니다. User Profile API의 경우 기본 1분당 10,000 건입니다. Event API의 경우 기본 1분당 10,000,000 건입니다. 제한을 늘리고 싶다면 디파이너리 고객성공팀에 문의 부탁드립니다. [디파이너리 고객성공팀 문의하기]
Rate Limit 의 현황을 확인하고 싶으시면 Response Header 의 X-Rate Limit 값을 통해 확인하실 수 있습니다.
Header Name | Type | Description |
X-Rate-Limit-Limit | string | 제한 기준(기간 - y, M, d, H, m, s) |
X-Rate-Limit-Remaining | integer | 제한 기준 내, 남은 조회 수 |
X-Rate-Limit-Reset | integer | Limit 제한 룰이 리셋되는 시간 타임스탬프 |
Example
Example | X-Rate-Limit-Limit | X-Rate-Limit-Remaining | X-Rate-Limit-Reset |
1일 100,000건인 경우 | 1d | 99,999 | 1682640000000 |
1시간 10,000건인 경우 | 1H | 9,999 | 1682593200268 |
1분 10,000건인 경우 | 1m | 9,999 | 1682593020036 |