File Safer 개요

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

공통 설정

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

아래의 가이드를 참조하여 API Gateway의 이용을 신청합니다.

API Gateway의 API Keys 메뉴로 이동하여 API Key를 생성 합니다.

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

Service	API	메서드	Request URI
Hash Filter	checkHash	GET	`https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/checkHash`
Hash Filter	getNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/getNotiConfig`
Hash Filter	setNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/setNotiConfig`
Hash Filter	getThresholdNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/getThresholdNotiConfig`
Hash Filter	setThresholdNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/setThresholdNotiConfig`
Hash Filter	removeThresholdNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/removeThresholdNotiConfig`
File Filter	inputFile	POST	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/inputFile`
File Filter	getInputFileLog	GET	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/getInputFileLog`
File Filter	getNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/getNotiConfig`
File Filter	setNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/setNotiConfig`
File Filter	getThresholdNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/getThresholdNotiConfig`
File Filter	setThresholdNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/setThresholdNotiConfig`
File Filter	removeThresholdNotiConfig	GET	`https://filesafer.apigw.gov-ntruss.com/filefilter/v1/removeThresholdNotiConfig`

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

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

HTTP 응답 코드	returnCode	returnMessage
200	0	success
200	140000	Unknown Error
200	140001	Parameter is invalid
200	140002	Not existent user
200	140003	Already in use
200	140004	Not allowed user
200	140005	Not existing the required parameter
200	140006	invalid request
200	140007	file size exceeds the limit
200	140009	Input file has a problem
200	140010	Unzip failed

이 문서가 도움이 되었습니까?

태그