메모장 읽기 API

v5

목차

1. API 개요

2. 구조 및 응답

   2-1. 전송 구조

   2-2. 수신 구조

   2-3. 응답 및 오류

3. 레퍼런스 코드

🟢 1. API 개요

주의 !

메모장 API v5는 6월 29일 이후 새로운 메모장 서비스와 호환되지 않습니다. ( DB, 백엔드 전부 변경됨 )
API 는 여전히 작동하지만, 메모장 서비스와 연동이 중지됩니다.
API v6 에서 백엔드 개선과 함께 적용될 예정입니다.

메모장 API 는 메모장 서비스에서 작성한 메모를 읽는 API 입니다.

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

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

🟢 2. 구조 및 응답

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

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

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

🔵 2 - 1. 전송 구조

GET

https://api.lrl.kr/v5/note/read?key=API_KEY&hash=riN6OsdQ

POST

{
    "key": "API_KEY",
    "hash": "riN6OsdQ"
}

POST 방식을 사용하는 경우 JSON 에 API Key와 hash 값을 넣어주시면 메모장의 내용을 가져옵니다.

( https://n.lrl.kr/riN6OsdQ ) 주소의 https://n.lrl.kr/ 뒷부분 영어 숫자 조합이 해시값입니다.

🔵 2 - 2. 수신 구조

{
     "result": {
          "content":"메모장 API 테스트용 메모입니다.",
          "is_password":"0"
     },
     "message":"SUCCESS"
}

content 는 해당 메모장의 내용입니다.

is_password 는 해당 메모가 암호화를 사용하는지 여부를 알려줍니다.

암호화가 걸린 메모의 복호화를 지원하지 않습니다. 암호화된 내용을 불러올 경우

j9PqWDaYCmmfs3+VD3hWwYjKB2gHPTziswE3BYivfJO1UDDK/gDFjxEh9ZLn7nN9w1Vnegh2sJ0gDZmTSO38DQ==

처럼 AES-256 으로 암호화 처리된 내용만 나옵니다.

🔴 2 - 3. 응답 및 오류

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

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

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

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

• ERR_NO_HASH : hash 값을 넣어주세요.
• ERR_NO_DATA : 해당 해시값이 맞는지 확인해주세요.
  
• ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.

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

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

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