1. 커뮤니티
  2. 사용안내
  3. 레거시

메모장 쓰기 API - v5

  • 22-06-18
  • 1,511 회
  • 0 건



메모장 쓰기 API

v5



목차

1. API 개요

2. 구조 및 응답

   2-1. 전송 구조

   2-2. 수신 구조

   2-3. 응답 및 오류

3. 레퍼런스 코드




🟢 1. API 개요


주의 !

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


메모장을 작성할 수 있는 API 입니다.

작성된 메모 내용은 별도의 해시 코드로 불러올 수 있습니다.


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

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




🟢 2. 구조 및 응답


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

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



🔵 2 - 1. 전송 구조
GET

https://api.lrl.kr/v5/note/write?key=API_KEY&content=메모내용


GET 방식을 사용하는 경우 위와 같이 API 를 사용하실 수 있습니다.

key 매개변수에 발급받은 API Key 를 넣고 content 매개변수는 메모장에 작성할 내용을 적어주시면 됩니다.



POST
{
    "key": "API_KEY",
    "content": "<p><b>굵게</b></p><p><u>밑줄</u></p><p><font color=\"#000000\" style=\"background-color: rgb(255, 255, 0);\">형광펜</font></p>"
}


POST 방식을 사용하는 경우 JSON 에 API key 값과 content 값을 넣어서 보내시면 메모가 작성되며, 해시값을 받을 수 있습니다.



🔵 2 - 2. 수신 구조


{
     "result": {
          "hash":"GR0gV09i"
     },
     "message":"SUCCESS"
}


hash 값이 해당 메모의 해쉬값입니다.

https://n.lrl.kr/GR0gV09i 에서 확인 가능하며, 메모장 읽기 API 에서도 확인 가능합니다.



🔴 2 - 3. 응답 및 오류


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

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


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


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


  • ERR_NO_CONTENT : 빈 메모입니다. 내용을 작성해주세요.
  • ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.



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


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

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

0
목록