고객센터
VRL.KR 이용에 필요한 도움을 드립니다.
API 안내
VRL.KR 단축 URL API의 기본 정보, 응답 형식, 인증 방법, 호출 제한을 안내합니다.
기본 정보
Q.VRL API란 무엇인가요?
VRL API는 자체 서비스나 스크립트에서 URL 단축 기능을 쓸 수 있게 제공하는 RESTful API입니다.
기본 주소: https://api.vrl.kr/v1
주요 기능: URL 단축, 링크 조회·삭제, 클릭 통계 조회.
Q.API 사용을 위해 필요한 것은 무엇인가요?
1. VRL.KR 회원가입
2. 개발자 페이지에서 API 키 발급
3. API 문서 확인
모든 회원이 무료로 API 키를 발급받을 수 있습니다.
기술
Q.API 응답 형식은 어떻게 되나요?
모든 응답은 JSON입니다.
성공: { "success": true, "data": { ... } }
실패: { "success": false, "error": { "code": "INVALID_REQUEST", "message": "..." } }
에러 코드: INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMIT, SERVER_ERROR
Q.API 호출 예시를 보여 주세요.
curl -X POST "https://api.vrl.kr/v1/urls" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com/long/url", "customAlias": "my-link"}'
인증·보안
Q.API 키는 어떻게 발급받나요?
1. 로그인
2. 개발자 페이지(/developers) 접속
3. 'API 키 발급' 클릭
API 키는 계정당 하나이며 언제든 재발급할 수 있습니다. 키는 발급 시 한 번만 표시되므로 안전한 곳에 보관하세요.
Q.API 키가 노출되었을 때는 어떻게 하나요?
개발자 페이지에서 즉시 '재발급'을 누르세요. 이전 키는 재발급과 동시에 만료됩니다.
제한 사항
Q.API 호출 제한이 있나요?
기본 한도는 키당 분당 60회, 일 5,000회입니다. 한도를 넘으면 429(RATE_LIMIT)를 돌려주며, 응답 헤더 X-RateLimit-* 로 남은 횟수를 확인할 수 있습니다.
더 큰 한도가 필요하면 [email protected] 로 문의해 주세요.
Q.API로 만든 링크의 유효기간을 정할 수 있나요?
네. 생성 요청에 expiresAt(ISO 8601) 또는 maxClicks 를 넣으면 됩니다. DELETE /v1/urls/{code} 로 즉시 비활성화할 수 있습니다.
원하는 답을 찾지 못하셨나요? [email protected] 로 문의해 주세요.