API 문서

OnURL API를 사용하여 프로그래밍 방식으로 URL을 단축하세요

목차
API 키 발급

회원가입 후 API 키를 발급받으세요.

회원가입

인증

모든 API 요청에는 Authorization 헤더에 Bearer 토큰으로 API 키를 포함해야 합니다.

Authorization: Bearer YOUR_API_KEY
API 키는 계정 설정에서 확인 및 재발급할 수 있습니다.

URL 단축

POST /api/shorten
요청 파라미터
파라미터 타입 필수 설명
url string 필수 단축할 원본 URL
custom_code string 선택 사용자 정의 단축 코드 (3-20자, 영문/숫자)
password string 선택 URL 접근 비밀번호
expires_at string 선택 만료일시 (YYYY-MM-DD HH:mm:ss)
요청 예시
curl -X POST https://onurl.cc/api/shorten \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/very/long/url",
    "custom_code": "mylink"
  }'
응답 예시
{
  "success": true,
  "data": {
    "short_url": "https://onurl.cc/mylink",
    "short_code": "mylink",
    "original_url": "https://example.com/very/long/url",
    "created_at": "2024-01-15 12:30:00"
  }
}

URL 정보 조회

GET /api/info/{short_code}
응답 예시
{
  "success": true,
  "data": {
    "short_code": "abc123",
    "original_url": "https://example.com/page",
    "click_count": 150,
    "unique_click_count": 89,
    "created_at": "2024-01-10 09:00:00",
    "expires_at": null
  }
}

에러 응답

{
  "success": false,
  "error": {
    "code": "INVALID_URL",
    "message": "유효하지 않은 URL입니다."
  }
}
에러 코드
코드 HTTP 상태 설명
UNAUTHORIZED 401 API 키가 없거나 유효하지 않음
INVALID_URL 400 유효하지 않은 URL 형식
CODE_EXISTS 409 이미 사용 중인 커스텀 코드
NOT_FOUND 404 URL을 찾을 수 없음
RATE_LIMIT 429 요청 한도 초과

요청 한도

API 요청은 다음과 같은 한도가 적용됩니다:

엔드포인트 한도 기간
/api/shorten 100회 시간당
/api/info/* 1000회 시간당
한도 초과 시 429 상태 코드가 반환됩니다. 더 높은 한도가 필요한 경우 문의해주세요.