URL 만들기 API - v3
- 21-09-13
- 1,802 회
- 0 건
URL 만들기 API
v3
목차
1. API 용도
2. 사용방법
3. 주의사항
4. 상태코드 및 메세지
5. 사용예제
1. API 용도
URL 만들기 API는 나만의 한글주소, 또는 영문주소를 만들 수 있습니다.
예를 들어 https://www.youtube.com 의 주소를 https://유튜브.lrl.kr 처럼 만들 수 있습니다.
또 다른 예시로 중고나라 주소가 계속 헷갈리셨다면 중고나라 주소 https://cafe.naver.com/joonggonara.cafe 를
https://중고나라.lrl.kr 처럼 만들어서 기억하기 쉽게 도와줍니다.
이모티콘 첨부도 가능합니다.
예시 : https://🍖.lrl.kr
v2 API 대비 30% 빨라진 응답속도 및 상태코드와 메세지 기능을 추가하여
API 사용 중 오류 원인을 빠르게 파악할 수 있습니다.
2. 사용방법
전송 메소드 : POST
응답 형식 : JSON
요구하는 데이터
JSON 형식으로 보내주세요.
- id 값
- url 값
https://api.lrl.kr/v3/url
를 기본 형식으로 사용합니다.
아래는 출력 방식에 따른 API 호출 코드입니다.
예시로 https://example.com 을 https://example.lrl.kr 로 만드는 코드입니다.
목차 5번의 사용예시도 참고해보세요.
인풋 ( INPUT )
{
"id": "example",
"url": "https://example.com"
}
아웃풋 ( OUTPUT )
{
"input": {
"id": "example",
"url": "https:\/\/example.com"
},
"result": "example.lrl.kr",
"message": "SUCCESS",
"time": "2021-09-13 10:23:42"
}
3. 주의사항
url 은 반드시 http:// 또는 https:// 를 넣어주셔야 정상적으로 생성 됩니다.
URL을 생성하다 보면 id 값이 겹치는 경우가 존재합니다.
이미 생성된 주소의 id 값과 url 값이 동일한 요청일 경우 같은 값을 반환하지만 ,
생성된 주소의 id값은 일치하나 url값이 일치하지 않을 경우 id 뒤에 임의의 3자리 코드를 붙여 생성합니다.
예시:
사용자 1 -> ( id: 네이버 url: https://naver.com 주소생성 = 네이버.lrl.kr )
사용자 2-> ( id: 네이버 url: https://daum.net 주소생성 = 네이버1dx.lrl.kr )
버그 및 오류 발견 시 신고 및 문의 게시판에 글을 남겨주세요. ( 비회원 글작성 가능 )
4. 상태 코드 및 메세지
v3 API 는 http 상태 코드와 메세지를 통해 api 의 오류를 파악할 수 있습니다.
HTTP 상태 코드
- 200 - 서비스 정상 제공중
- 201 - 요청 성공
- 400 - 잘못된 요청
- 403 - 접근 불가능
- 404 - 존재하지 않는 리소스
- 405 - 잘못된 메소드 ( POST 이외는 사용 불가능 )
메세지
SUCCESS : 요청 및 응답 성공
ERR_NO_ID : ID 값을 입력해주세요.
ERR_NO_URL : URL 값을 입력해주세요.
ERR_UNAVAILABLE_CHAR_ID1 : ID 값에 사용 불가능한 문자가 들어있습니다. (1)
ERR_UNAVAILABLE_CHAR_ID2: ID 값에 사용 불가능한 문자가 들어있습니다. (2)
ERR_HTTP/S_REQUIRED_IN_URL : URL 에 http:// 또는 https:// 가 필요합니다.
5. 사용예제
사용 예제는 하단의 첨부 파일에 첨부해두었습니다.
미리보기 ( Ajax ) : https://api.lrl.kr/ref/v3/url/ajax.html
미리보기 ( JSON ) : https://api.lrl.kr/ref/v3/url/json.php
- ajax.html
- json.php
- URL 만들기 레퍼런스 v3.zip (3.4K) 13 회
- 이전글 URL 안전 검사 API - v3 21.09.13
- 다음글 URL 단축 API - v3 21.09.13