url 만들기 API

v5

목차

1. API 개요

2. 구조 및 응답

   2-1. 전송 구조

   2-2. 수신 구조

   2-3. 응답 및 오류

3. 레퍼런스 코드

🟢 1. API 개요

URL 만들기 API 는 긴 주소를 원하는 형태로 만들어 사용 가능한 API입니다.

예를 들어 중고나라 ( https://cafe.naver.com/joonggonara.cafe ) 주소를 기억하기 쉽게

https://중고나라.lrl.kr 처럼 만들 수 있습니다.

v5 버전의 API 부터 API Key 를 발급받아야 사용이 가능합니다.

LRL.KR 로그인 후 https://api.lrl.kr 에서 키 발급이 가능합니다.

🟢 2. 구조 및 응답

• 요청 URL : https://api.lrl.kr/v5/url/create 
• 데이터 타입 : JSON
• 전송 메소드 : GET, POST

GET 방식은 URI 를 통해 데이터 전송이 가능하며, JSON 타입 데이터를 받습니다.

POST 방식은 JSON 타입 데이터를 주고 받습니다.

🔵 2 - 1. 전송 구조

GET

https://api.lrl.kr/v5/url/create?key=API_KEY&id=네이버&url=https://naver.com

GET 방식을 사용하는 경우 API Key 값과 id, url 값을 넣으시면

 id.lrl.kr 형태의 주소가 만들어지고 해당 주소를 클릭하면 url 값으로 이동됩니다.

POST

{
     "key": "API_KEY",
     "id": "네이버이동",
     "url": "https://naver.com"
}

POST 방식을 사용하는 경우 JSON 형식에 API Key 값과 id, url 값을 넣으시면

 id.lrl.kr 형태의 주소가 만들어지고 해당 주소를 클릭하면 url 값으로 이동됩니다.

🔵 2 - 2. 수신 구조

{
     "result": {
          "url":"네이버이동.lrl.kr"
     },
     "message":"SUCCESS"
}

위 형태의 응답을 받습니다.

result -> url 값이 만들어진 주소입니다.

🔴 2 - 3. 응답 및 오류

API 는 아래와 같은 http 코드로 응답합니다.

정상적인 응답에는 http 201 값을 반환합니다.

• 200 - 서비스 정상 제공중
• 201 - 요청 성공
• 400 - 잘못된 요청
• 401 - API 키 누락 또는 불일치
• 403 - 접근 불가능
• 404 - 존재하지 않는 리소스
• 405 - 잘못된 요청 메소드
• 500 - 서버 오류. 신고 및 문의 게시판에 제보해주세요.

만약 오류가 난 경우 message 값에 다음 메세지를 반환합니다.

• ERR_NO_ID : ID 값을 넣어주세요.
• ERR_NO_URL : URL 값을 넣어주세요.
• ERR_INVALID_URL : 올바르지 않은 URL ( https:// 필요 )
• ERR_INVALID_CHAR_IN_ID : ID 값에 특수문자 또는 지원하지 않는 문자가 있습니다.
  
• ERR_URL_ALREADY_EXISTS : 이미 존재하는 주소입니다 (중복 방지).
• ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.

🟢 3. 레퍼런스 (예제) 코드

레퍼런스는 https://api.lrl.kr/ref/v5/ 에서 확인하실 수 있습니다.

크롬 기준 우클릭 -> 페이지 소스 보기 를 눌러서 코드를 확인하세요.