File Safer の概要
- 印刷する
- PDF
File Safer の概要
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
概要
File Safer APIは RETSTful形式で提供され、提供される APIを呼び出すためには API Gatewayの IAM認証を行う必要があります。
共通設定
IAM認証
File Saferの APIは API Gatewayを通じて提供するため、API Gatewayの利用時に必要な IAM認証のためにご利用の申し込みと API Keyが必要です。
API Gatewayサービスのご利用の申し込みをします。(API Gatewayの紹介)
API Gatewayの API Keysメニューに移動し、API Keyを作成します。(API Keyを作成する)
File Saferの APIの Subscription Typeは公開-自主購読(Public)であるため、別途の購読手続きなしに作成した API Keyを用いて使用できます。
API
Service | API | Method | Request URI |
---|---|---|---|
Hash Filter | checkHash | GET | https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash |
Hash Filter | getNotiConfig | GET | https://filesafer.apigw.ntruss.com/hashfilter/v1/getNotiConfig |
Hash Filter | setNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig |
Hash Filter | getThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/getThresholdNotiConfig |
Hash Filter | setThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/setThresholdNotiConfig |
Hash Filter | removeThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/removeThresholdNotiConfig |
File Filter | inputFile | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/inputFile |
File Filter | getInputFileLog | GET | https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog |
File Filter | getInputFileLogByParentHash | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLogByParentHash |
File Filter | getNotiConfig | GET | https://filesafer.apigw.ntruss.com/filefilter/v1/getNotiConfig |
File Filter | setNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig |
File Filter | getThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/getThresholdNotiConfig |
File Filter | setThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/setThresholdNotiConfig |
File Filter | removeThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/removeThresholdNotiConfig |
リクエストヘッダ
IAM認証のためのリクエストヘッダです。
ヘッダ名 | 説明 |
---|---|
x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したものです。 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
x-ncp-apigw-api-key | API Gatewayから発行されたキー |
x-ncp-iam-access-key | NAVERクラウドプラットフォームから発行された API Keyまたは IAMから発行された AccessKey |
x-ncp-apigw-signature-v2 | リクエストパスとヘッダを AccessKeyとマッピングされる SecretKeyで暗号化した署名として HMAC暗号化アルゴリズムは HmacSHA256を使用 IAM認証が必要な APIを呼び出すを参照 |
エラーコード
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 |
共通エラー
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 |
この記事は役に立ちましたか?