url 검사 API

v5

목차

1. API 개요

2. 구조 및 응답

   2-1. 전송 구조

   2-2. 수신 구조

   2-3. 응답 및 오류

3. 레퍼런스 코드

🟢 1. API 개요

URL 검사 API 는 URL이 안전한 주소인지 검사하는 API 입니다.

해당 API 는 구글 세이프 브라우징 API 의 캐시, 즉 결과값을 가져와서 저장하고 빠르게 출력하는 API 입니다.

미국에서 한국까지의 지연 시간이 길어서 검사 결과를 24시간마다 갱신하는 API 입니다.

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

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

🟢 2. 구조 및 응답

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

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

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

🔵 2 - 1. 전송 구조

GET

https://api.lrl.kr/v5/url/check?key=API_KEY&url=http://malware.testing.google.test/testing/malware/*

key 매개변수에 발급받은 API 키를 넣어주시고 url 매개변수에는 안전검사를 진행할 URL을 넣어주시면 됩니다.

POST

{
    "key": "API_KEY",
    "url": "http://malware.testing.google.test/testing/malware/*"
}

POST 방식을 사용하는 경우 위와 같이 JSON 형태의 API Key와 url 값을 전송하면 검사한 주소의 안전 여부를 검사하고 결과를 보여줍니다.

예시의 구조 속 주소는 멀웨어 테스트용 주소로 실제 바이러스가 있는 주소가 아닙니다.

🔵 2 - 2. 수신 구조

{
     "result": {
          "safe":"0",
          "threat":"MALWARE"
     },
     "message":"SUCCESS"
}

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

result -> safe 값은 위험 여부를 알려줍니다.

safe 값이 0이면 위험한 주소, 1이면 안전한 주소입니다.

result -> threat 값은 위험 요소 종류를 알려줍니다.

예시의 주소는 검사한 주소에 멀웨어가 있음을 알 수 있습니다.

( 검사 테스트용 주소로, 실제 멀웨어는 없습니다. )

🔴 2 - 3. 응답 및 오류

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

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

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

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

• ERR_NO_URL : URL 값을 넣어주세요.
• ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.

위험한 URL 인 경우 threat 값에 원인이 출력됩니다.

• MALWARE : 해당 사이트에 멀웨어 감지되었습니다.
• SOCIAL_ENGINEERING : 피싱 및 사기성 사이트.
• UNWANTED_SOFTWARE : 원하지 않는 소프트웨어.
• THREAT_TYPE_UNSPECIFIED : 알려지지 않은 위협.
• POTENTIALLY_HARMFUL_APPLICATION : 잠재적으로 위험한 어플리케이션.
  

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

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

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