URL 안전 검사 API - v3


URL 검사 API
v3




목차

1. API 용도

2. 사용방법

3. 주의사항

4. 상태코드 및 메세지

5. 사용예제





1. API 용도


URL값을 받아 구글 API로 사이트 멀웨어 검사 후 검사 결과를 알려줍니다.

검사 결과는 Mysql DB에 하루동안 캐시되며, 24시간마다 결과를 자동으로 갱신합니다.

LRL.KR에서 현재 사용중인 URL 검사 API 입니다.


v2 API 대비 30% 빨라진 응답속도 및 상태코드와 메세지 기능을 추가하여

API 사용 중 오류 원인을 빠르게 파악할 수 있습니다.





2. 사용방법


전송 메소드 : POST

응답 형식 : JSON



요구하는 데이터


JSON 형식으로 보내주세요.


  • url 값


https://api.lrl.kr/v3/check

를 기본 형식으로 사용합니다.



아래는 출력 방식에 따른 API 호출 코드입니다.

예시로 https://example.com 을 검사하는 코드입니다.


목차 5번의 사용예시도 참고해보세요.



인풋 ( INPUT )
{
  "url": "https://example.com"
}


아웃풋 ( OUTPUT )
{
    "input": {
        "url": "https:\/\/example.com"
    },
    "result": 1,
    "message": "SUCCESS",
    "time": "2021-09-13 23:06:03"
}


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



3. 주의사항


버그 및 오류 발견 시 신고 및 문의 게시판에 글을 남겨주세요. ( 비회원 글작성 가능 )





4. 상태 코드 및 메세지


v3 API 는 http 상태 코드와 메세지를 통해 api 의 오류를 파악할 수 있습니다.



HTTP 상태 코드


  • 200 - 서비스 정상 제공중
  • 201 - 요청 성공
  • 400 - 잘못된 요청
  • 403 - 접근 불가능
  • 404 - 존재하지 않는 리소스
  • 405 - 잘못된 메소드 ( POST 이외는 사용 불가능 )



메세지


SUCCESS : 요청 및 응답 성공

ERR_NO_URL : URL 값을 입력해주세요.

ERR_UNDEFINED : 서버 오류일 확률이 높습니다. 신고 및 문의 게시판에 글을 남겨주세요.





5. 사용예제


사용 예제 파일은 하단의 첨부 파일에 첨부해두었습니다.


미리보기 ( ajax.html ) : https://api.lrl.kr/ref/v3/check/ajax.html 

미리보기 ( json.php ) : https://api.lrl.kr/ref/v3/check/json.php


  • ajax.html 
  • json.php