API 문서
숏.한국 URL 단축 API를 사용하여 프로그래밍 방식으로 URL을 단축하세요.
기본 정보
비회원은 24시간에 3개까지 무료로 만들 수 있어요.
- Base URL:
https://숏.한국/api/v1/shorten - 형식: JSON
- 인증: 선택 (없으면 임시 주소, API 키가 있으면 본인 코드 주소)
인증 (API 키)
로그인한 뒤 프로필에서 API 키를 만들고, 요청 헤더에 넣어 보내세요. 키를 보내면 링크가 본인 코드 주소(숏.한국/본인코드/코드)로 만료 없이 만들어지고, 대시보드에서 수정·통계 확인을 할 수 있습니다.
Authorization: Bearer sk_short_...- 키는 만들 때 한 번만 보여 줍니다. 잃어버렸다면 폐기하고 새로 만드세요.
- 계정당 최대 5개, 키당 분당 30건·하루 1,000건까지 요청할 수 있습니다. 넘으면 429 응답과 Retry-After 헤더를 돌려줍니다.
- 키가 틀리거나 폐기됐으면 임시 주소로 바꾸지 않고 401 응답을 돌려줍니다.
URL 단축 요청
POST /api/v1/shorten
요청 파라미터:
| 파라미터 | 필수 | 설명 |
|---|---|---|
original_url | ✅ | 단축할 원본 URL |
custom_code | ❌ | 사용자 지정 단축 코드 (미입력시 자동 생성) |
expire_duration | ❌ | 만료 기간: 24h, 48h, 1week, 1month |
code_id | ❌ | API 키 사용 시: 쓸 본인 코드 ID (미입력시 기본 코드). temp 를 주면 임시 주소로 만들고 대시보드에서 관리됩니다. |
예제 요청:
curl -X POST https://숏.한국/api/v1/shorten \
-H "Content-Type: application/json" \
-d '{
"original_url": "https://example.com/very-long-url",
"custom_code": "예제",
"expire_duration": "1week"
}'성공 응답 (201):
{
"status": "success",
"message": "URL이 성공적으로 단축되었습니다.",
"data": {
"short_url": "https://숏.한국/예제/",
"original_url": "https://example.com/very-long-url",
"code": "예제",
"expiration_date": "2026-04-21T10:00:00.000Z"
}
}API 키로 요청:
curl -X POST https://숏.한국/api/v1/shorten \
-H "Authorization: Bearer sk_short_..." \
-H "Content-Type: application/json" \
-d '{
"original_url": "https://example.com/very-long-url",
"custom_code": "예제"
}'API 키 성공 응답 (201):
{
"status": "success",
"message": "URL이 성공적으로 단축되었습니다.",
"data": {
"short_url": "https://숏.한국/본인코드/예제/",
"original_url": "https://example.com/very-long-url",
"code": "예제",
"expiration_date": "2126-03-28T10:00:00.000Z",
"username": "본인코드",
"user_code_id": 12,
"is_temp": false
}
}에러 응답:
{
"status": "error",
"message": "이미 사용 중인 단축 코드입니다."
}API 정보 확인
GET /api/v1/shorten
API 엔드포인트 정보와 사용 가능한 파라미터를 반환합니다.