Support
Help with using VRL.KR.
API guide
Basics of the VRL.KR URL shortening API: response format, authentication, and rate limits.
Basics
Q.What is the VRL API?
The VRL API is a RESTful API that lets your own service or scripts shorten URLs.
Base URL: https://api.vrl.kr/v1
Main features: shorten URLs, list and delete links, and retrieve click statistics.
Q.What do I need to use the API?
1. A VRL.KR account
2. An API key from the developer page
3. The API documentation
Every member can issue an API key for free.
Technical
Q.What does the API response look like?
All responses are JSON.
Success: { "success": true, "data": { ... } }
Failure: { "success": false, "error": { "code": "INVALID_REQUEST", "message": "..." } }
Error codes: INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMIT, SERVER_ERROR
Q.Can you show an example request?
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"}'
Authentication & security
Q.How do I get an API key?
1. Sign in
2. Open the developer page (/developers)
3. Press 'Issue API key'
Each account has one key, which can be regenerated at any time. The key is shown only once, so store it safely.
Q.What if my API key is exposed?
Press 'Regenerate' on the developer page immediately. The previous key stops working as soon as a new one is issued.
Limits
Q.Is there a rate limit?
The default limit is 60 requests per minute and 5,000 per day per key. Above that the API returns 429 (RATE_LIMIT); the X-RateLimit-* response headers show your remaining quota.
If you need a higher limit, contact [email protected].
Q.Can links created via the API expire?
Yes. Include expiresAt (ISO 8601) or maxClicks in the create request. DELETE /v1/urls/{code} deactivates a link immediately.
Didn't find what you were looking for? Email [email protected].