URL 단축 API - v3
- 21-09-13
- 1,604 회
- 0 건
URL 단축 API
v3
목차
1. API 용도
2. 사용방법
3. 주의사항
4. 상태코드 및 메세지
5. 사용예제
1. API 용도
URL 단축 API 는 긴 주소를 짧게 줄여줍니다.
예시로 https://section.blog.naver.com/BlogHome.naver?directoryNo=0¤tPage=1&groupId=0 같은 긴 주소를
https://lrl.kr/dDCz 처럼 줄여줍니다.
단축한 주소는 저장 및 공유 시 유용하게 사용이 가능합니다.
v2 API 대비 30% 빨라진 응답속도 및 상태코드와 메세지 기능을 추가하여
API 사용 중 오류 원인을 빠르게 파악할 수 있습니다.
2. 사용방법
전송 메소드 : POST
응답 형식 : JSON
요구하는 데이터
- url 값
https://api.lrl.kr/v3/short
를 기본 형식으로 사용합니다.
아래는 출력 방식에 따른 API 호출 코드입니다.
예시로 https://example.com 을 단축하는 코드입니다.
https://example.com 이 부분을 원하시는 주소로 바꿔 사용해주세요.
인풋 ( INPUT )
{
"url": "https://example.com"
}
아웃풋 ( OUTPUT )
{
"input": {
"url": "https:\/\/example.com"
},
"result": "https:\/\/lrl.kr\/wV",
"message": "SUCCESS",
"time": "2021-09-13 09:57:35"
}
3. 주의사항
url 은 반드시 http:// 또는 https:// 를 넣어주셔야 정상적으로 단축됩니다.
버그 및 오류 발견 시 신고 및 문의 게시판에 글을 남겨주세요. ( 비회원 글작성 가능 )
4. 상태 코드 및 메세지
v3 API 는 http 상태 코드와 메세지를 통해 api 의 오류를 파악할 수 있습니다.
HTTP 상태 코드
- 200 - 서비스 정상 제공중
- 201 - 요청 성공
- 400 - 잘못된 요청
- 403 - 접근 불가능
- 404 - 존재하지 않는 리소스
- 405 - 잘못된 메소드 ( POST 이외는 사용 불가능 )
메세지
SUCCESS : 요청 및 응답 성공
ERR_BAD_INPUT : 올바르지 않은 요청입니다.
ERR_NO_URL : URL 값을 받지 못했습니다.
ERR_HTTP/S_REQUIRED_IN_URL : URL 에 http:// 또는 https:// 가 필요합니다.
ERR_SHORTENED_URL : 이미 단축된 URL입니다.
5. 사용예제
사용 예제는 하단의 첨부 파일에 첨부해두었습니다.
미리보기 ( Ajax ) : https://api.lrl.kr/ref/v3/short/ajax.html
미리보기 ( JSON ) : https://api.lrl.kr/ref/v3/short/json.php
- ajax.html
- json.php
- URL 단축 API 레퍼런스 v3.zip (2.8K) 17 회
- 이전글 URL 만들기 API - v3 21.09.13
- 다음글 URL 안전 검사 API - v2 ( Legacy ) 21.08.30