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

메모장 읽기 API

  • 22-02-13
  • 1,506 회
  • 0 건



메모장 읽기 API

v4



목차

1. API 개요

2. 구조 및 응답

   2-1. 전송 구조

   2-2. 수신 구조

   2-3. 응답 및 오류

3. 레퍼런스 코드




🟢 1. API 개요


메모장 읽기 API 는 메모장 쓰기 API 또는 메모장 서비스에서 작성한 메모를

읽을 때 사용하는 API 입니다.




🟢 2. 구조 및 응답


POST 메소드로 전송하며 JSON 타입 데이터를 주고 받습니다.



🔵 2 - 1. 전송 구조


{ 
    hash: "riN6OsdQ"
}


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 - 잘못된 요청
  • 403 - 접근 불가능
  • 404 - 존재하지 않는 리소스
  • 405 - 잘못된 요청 메소드
  • 500 - 서버 오류. 신고 및 문의 게시판에 제보해주세요.


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


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



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


레퍼런스는 참고자료 라는 뜻으로, API 사용 예제를 보여줍니다.

코드 수정은 자유입니다.


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

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


또는 크롬 브라우저에 view-source:https://api.lrl.kr/ref/v4/ 를 입력하시면 소스 코드가 나옵니다.


0
목록