VRL API

VRL.KR 공개 API(api.vrl.kr/v1)로 단축 URL 생성·조회·삭제·클릭 통계를 프로그램에서 사용하세요. API 키는 회원 누구나 무료로 발급됩니다.

API 키
계정당 1개, 무료. 키는 발급 직후 한 번만 표시되며 서버에는 해시만 저장됩니다.

API 키는 로그인 후 무료로 발급됩니다.

회원 누구나 계정당 1개. 결제나 플랜 없이 바로 사용할 수 있습니다.

로그인회원가입
시작하기

Base URL

https://api.vrl.kr

인증 헤더

Authorization: Bearer vrl_live_…
curl -X POST "https://api.vrl.kr/urls" \
  -H "Authorization: Bearer vrl_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/very/long/path"}'

# 응답
{"success":true,"data":{"code":"Ab3xYz","shortUrl":"https://vrl.kr/Ab3xYz","originalUrl":"https://example.com/very/long/path","status":"ACTIVE","clickCount":0,...}}
  • 모든 응답은 { success, data } 또는 { success:false, error:{ code, message } } 형식입니다.
  • 레이트리밋: 분당 60회 · 일 5,000회. 헤더 X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset(초)로 확인합니다.
  • OpenAPI 명세: https://api.vrl.kr/openapi.json
엔드포인트
서버의 OpenAPI 명세에서 자동 생성됩니다.
get/v1/urls— 내 단축 URL 목록

최신순. page는 1부터, limit 최대 100.

파라미터

이름위치타입설명
pagequeryinteger페이지(1부터)
limitqueryinteger페이지 크기(1~100)
qquerystring코드·원본 URL·제목 검색어
statusqueryACTIVE | EXPIRED | BLOCKED상태 필터: ACTIVE | EXPIRED | BLOCKED

예시

curl -X GET "https://api.vrl.kr/v1/urls?page=1&limit=20" \
  -H "Authorization: Bearer vrl_live_YOUR_API_KEY"

응답: 200 OK

post/v1/urls— 단축 URL 생성

원본 URL을 단축합니다. 커스텀 별칭·제목·만료 시각·최대 클릭 수를 지정할 수 있습니다.

요청 본문 (application/json)

필드타입설명
url*string단축할 원본 URL(http/https)예: https://example.com/very/long/path?x=1
customAliasstringnull커스텀 별칭 3~30자 [A-Za-z0-9_-]. 생략하면 6자 랜덤 코드예: my-link
titlestringnull제목(메모)
expiresAtdatetime (ISO-8601)만료 시각(ISO-8601). 이후 접속 시 만료 안내예: 2027-01-01T00:00:00Z
maxClicksintegernull최대 클릭 수. 도달 시 만료예: 1000

예시

curl -X POST "https://api.vrl.kr/v1/urls" \
  -H "Authorization: Bearer vrl_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/very/long/path","customAlias":"my-link"}'

응답: 201 생성됨 · 400 INVALID_REQUEST — URL 형식·별칭 규칙 위반, 예약어 · 409 CONFLICT — 이미 사용 중인 별칭

get/v1/urls/{code}— 단축 URL 상세

코드로 내 링크 하나를 조회합니다.

파라미터

이름위치타입설명
code*pathstring

예시

curl -X GET "https://api.vrl.kr/v1/urls/abc123" \
  -H "Authorization: Bearer vrl_live_YOUR_API_KEY"

응답: 200 OK

delete/v1/urls/{code}— 단축 URL 삭제

링크와 클릭 기록을 삭제합니다. 되돌릴 수 없습니다.

파라미터

이름위치타입설명
code*pathstring

예시

curl -X DELETE "https://api.vrl.kr/v1/urls/abc123" \
  -H "Authorization: Bearer vrl_live_YOUR_API_KEY"

응답: 200 OK

get/v1/urls/{code}/stats— 클릭 통계

기간별 총 클릭·순 클릭·일별 추이·국가·기기·OS·브라우저·유입경로 상위 10개.

파라미터

이름위치타입설명
code*pathstring
periodquerystring7d | 30d | 90d | all

예시

curl -X GET "https://api.vrl.kr/v1/urls/abc123/stats?period=30d" \
  -H "Authorization: Bearer vrl_live_YOUR_API_KEY"

응답: 200 OK

에러 코드
HTTPcode설명
400INVALID_REQUEST요청 형식 오류(URL 형식, 별칭 규칙, 예약어, 만료일 등)
401UNAUTHORIZEDAPI 키 누락 또는 유효하지 않음
403FORBIDDEN권한 없음(차단된 링크 수정 등)
404NOT_FOUND내 계정에 없는 코드
409CONFLICT이미 사용 중인 별칭
429RATE_LIMIT분당·일일 요청 한도 초과. Retry-After 헤더 참고
500SERVER_ERROR서버 오류
브라우저에서 바로 줄이기
아래 버튼을 북마크바로 끌어다 놓으면 북마클릿이 저장됩니다. 줄이고 싶은 페이지에서 북마크를 누르면 VRL.KR 이 열리며 주소가 자동으로 채워지고 바로 단축됩니다. 로그인 상태라면 회원 링크로 만들어져 대시보드에서 관리할 수 있습니다.
VRL로 줄이기

이 버튼을 북마크바로 드래그하세요

  1. 위 버튼을 브라우저 북마크바로 드래그합니다. (Safari·모바일은 북마크를 만든 뒤 주소를 아래 코드로 바꿉니다.)
  2. 단축하고 싶은 페이지에서 저장한 북마크를 누릅니다.

북마클릿 코드

javascript:(function(){location.href='https://vrl.kr/?auto=1&url='+encodeURIComponent(location.href)})()

크롬 확장 프로그램

저장소의 extension/ 폴더에 Manifest V3 확장 소스가 있습니다. 옵션에 API 키를 넣으면 팝업에서 현재 탭 주소를 바로 줄이고 복사할 수 있습니다. 개발자 모드 → '압축해제된 확장 프로그램 로드'로 설치합니다.

자주 묻는 질문
API 키는 어떻게 발급받나요?
회원가입 후 이 페이지에서 'API 키 발급' 버튼을 누르면 즉시 발급됩니다. 계정당 1개이며 무료입니다.
요청 한도는 얼마인가요?
기본 분당 60회, 일 5,000회입니다. 응답 헤더 X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset(초)으로 남은 한도를 확인할 수 있습니다.
API로 만든 링크도 대시보드에서 볼 수 있나요?
네. API 키는 계정에 귀속되므로 API로 만든 링크는 대시보드 목록·통계에 그대로 표시됩니다.
브라우저에서 바로 줄일 수 있나요?
네. 이 페이지 하단의 북마클릿을 북마크바로 끌어다 놓으면, 보고 있는 페이지에서 북마크를 눌러 바로 단축할 수 있습니다. 크롬 확장 소스도 제공합니다.

기타 문의는 API 안내 또는 [email protected] 으로.