Site Safer

참고

네이버 클라우드 플랫폼의 상품 사용 방법을 보다 상세하게 제공하고, 다양한 API의 활용을 돕기 위해 [설명서][API 참조서]를 구분하여 제공하고 있습니다.

Site Safer API 참조서 바로가기 >>
Site Safer 설명서 바로가기 >>

개요

Site Safer API는 HTTP 형태로 제공되며, 제공되는 API를 호출하기 위해서는 API Gateway의 IAM 인증을 수행해야 합니다.

공통 설정

IAM 인증

Site Safer의 API는 API Gateway를 통해 제공되므로 API Gateway이용 시 필요한 IAM 인증을 위해 이용 신청 및 API Key가 필요합니다.

Site Safer의 API의 Subscription Type은 공개-자율구독(Public)이므로 별도의 구독과정없이 생성하신 API Key를 이용하여 사용 가능합니다.

API

Service API Method Request URI
Site Safer 그룹 생성 createUrlGroup POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/createUrlGroup
Site Safer 그룹 조회 getUrlGroup POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/getUrlGroup
Site Safer 그룹 삭제 removeUrlGroup POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/removeUrlGroup
Site Safer 그룹에 URL 추가 addInspectionUrl POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/addInspectionUrl
Site Safer 그룹의 URL 조회 getInspectionUrl POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/getInspectionUrl
Site Safer 그룹의 URL 삭제 deleteInspectionUrl POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/deleteInspectionUrl
Site Safer 그룹에 검사 일정 추가 setInspectionSchedule POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/setInspectionSchedule
Site Safer 그룹의 검사 일정 조회 getUrlGroupInspectionSchedule POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/getUrlGroupInspectionSchedule
Site Safer 그룹의 검사 일정 삭제 deleteInspectionSchedule POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/deleteInspectionSchedule
Site Safer 그룹의 검사 결과 조회 getInspectionResult POST https://sitesafer.apigw.ntruss.com/sitesafer/v1/getInspectionResult

요청 헤더

IAM 인증을 위한 요청 헤더입니다.

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것입니다.
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key 포털 마이페이지의 인증키 관리 메뉴에서 발급받은 Access Key ID 또는 콘솔 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2 요청 경로 및 헤더를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명으로
HMAC 암호화 알고리즘은 HmacSHA256 사용

IAM 인증이 필요한 API 호출하기를 참조 합니다.
accept ‘application/json’

오류 코드

HTTP 응답 코드 ErrorCode ErrorMessage
400 100 Bad Request Exception
401 200 Authentication Failed
401 210 Permission Denied
404 300 Not Found Exception
429 400 Quota Exceeded
429 410 Throttle Limited
429 420 Rate Limited
413 430 Request Entity Too Large
503 500 Endpoint Error
504 510 Endpoint Timeout
500 900 Unexpected Error