File Saferの概要

Prev Next

Classic/VPC環境で利用できます。

File Saferは、ウェブを介して提供されるファイルとアウトリンクにマルウェアが含まれていないか検査する NAVERクラウドプラットフォームのサービスですFail Saferサービスでは Hash Filter、File Filter機能関連の APIを RETSTful形式で提供します。

File Saferの共通設定

File Safer APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです

Hash Filter: https://filesafer.apigw.ntruss.com/hashfilter/v1
File Filter: https://filesafer.apigw.ntruss.com/filefilter/v1

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
    		•
    x-ncp-apigw-api-key Required NAVERクラウドプラットフォームの API Gatewayから発行された APIキー
    x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
  • Access Keyの発行と確認: 認証キーの作成を参照
  • サブアカウントの Access Key発行と確認: サブアカウントの作成を参照
    		•
    x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
  • Secret Keyの発行と確認: 認証キーの作成を参照
  • 署名の作成: シグネチャーの作成を参照
    		•
    Accept Required レスポンスデータの形式
  • application/json
    		•

    レスポンス

    共通レスポンス形式を説明します

    レスポンスステータスコード

    レスポンスステータスコードは次の通りです。

    HTTPステータスコード コード メッセージ
    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
    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
    参考

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    File Safer API

    File Saferサービスで提供する APIの説明は次の通りです。

    Hash Filter

    Hash Filter関連の APIは次の通りです。

    API 説明
    checkHash ファイルまたは URLストリングが悪性かどうかを確認
    getNotiConfig 分析結果の通知設定を照会
    getThresholdNotiConfig 分析結果通知の高度な設定を照会
    removeThresholdNotiConfig 分析結果通知の高度な設定を削除
    setNotiConfig 分析結果の通知設定
    setThresholdNotiConfig 分析結果通知の高度な設定

    File Filter

    File Filter関連の APIは次の通りです。

    API 説明
    getInputFileLog InputFile APIで転送したファイルの分析結果を照会
    getInputFileLogByParentHash InputFile APIで転送した圧縮ファイル内ファイルの分析結果を照会
    getNotiConfig 分析結果の通知設定を照会
    getThresholdNotiConfig 分析結果通知の高度な設定を照会
    InputFile File Filterで分析するのファイルを転送
    removeThresholdNotiConfig 分析結果通知の高度な設定を削除
    setNotiConfig 分析結果の通知設定
    setThresholdNotiConfig 分析結果通知の高度な設定

    File Safer関連リソース

    File Safer APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。