本API referenceは旧バージョンであり、これ以上アップデートされません。最新の内容はAPI参照書をご参考ください。

APIの概要

NAVERクラウドプラットフォームAPIについて説明します。

NAVERクラウドプラットフォームはNAVERの最新のコンピューティング技術と運用ノーハウが蓄積されたクラウドサービスです。

NAVERクラウドプラットフォームで提供する様々な商品群の中でソリューション商品を利用できるように提供する応用プログラムインターフェース(API)をNAVERクラウドプラットフォームAPIといいます。

NAVERクラウドAPIはAPI Gatewayを利用したRESTfulの形で提供され、HTTP方式のGET/POSTメソッドの呼び出しによって行われます。

API Gateway

File SaferのAPIはNAVERクラウドプラットフォームのAPI Gatewayを利用して提供されます。

次の内容で確認できるhashfilter, filefilter APIはPublic駆動方式により登録手続きなしに利用でき、Published APIsで次のProcduct名で確認可能です。

  • Product名: File Safer
  • 説明: NAVER CLOUD PLATFORM FILE-SAFER

Auth

IAM Auth

NAVERクラウドプラットフォームで提供するRest-APIはAPI Gatewayを利用し、IAM認証が必要です。 次のIAM認証が必要なAPIの呼び出しリンク先で認証値の作成およびAPIの呼び出しの内容をご参考ください。

Hash Filter

checkHash

APIリクエストの構成

API URL + アクション + アクションパラメータ + AUTHPARMS

区分 説明
API URL NAVERクラウドプラットフォームFile Safer (Hash Filter) API URL
https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash
転送方式 GET
アクション Hash FilterはHash照会のアクションを提供します。
アクションパラメータ Hash値を指定するhashCodeパラメータとHashアルゴリズムを指定するhashTypeパラメータをサポートします。
AUTHPARAMS x-ncp-apigw-timestamp={timestamp}
x-ncp-apigw-api-key={apiKey}
x-ncp-iam-access-key={accesskey}
x-ncp-apigw-signature-v2={signature}

APIリクエストのアクションパラメータ

名前(Key) タイプ 説明
hashCode String 照会しようとするHash値です。
hashType String 照会しようとするHashを抽出したアルゴリズム区分値で、md5, sha1をサポートします。

APIリクエストのSample

curl -X GET "https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash?hashCode=f093e7767bb63ac973b697d3fd1d40a78b87b8bf&hashType=sha1"
   -H "accept: application/json"
   -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

APIレスポンスのフォーマット

JSONフォーマットをサポートします。

区分 レスポンス
検知された場合 {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "hashCheckResultList": [
        {
            "hashType": "sha1",
            "hashCode": "213ce10c4298c7617aac93615c3c3b0a783fd304",
            "group": "file",
            "result": "1",
            "regDateTime": "1497409737000"
        }
    ]
}
検知されていない場合 {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 0,
    "hashCheckResultList": []
}

APIレスポンスの構成

項目 説明
returnCode リクエストに対する処理結果のコードです。
returnMessage リクエストに対する処理結果のメッセージです。
totalRows hashCheckResultListのobjectの数です。
hashCheckResultList リクエストしたHashに該当する検知件に関する情報で、リストにobjectがある場合、悪意のあるコードとして処理します。
hashType hashcodeのアルゴリズム区分であり、MD5, SHA-1をサポートします。
hashCode 検知されたHash値です。
group 検知されたHash値がFile objectの値である場合は‘file’で表記され、URLのストリングである場合は‘url’で表記されます。
result リクエストしたHashが検知された場合は“1”、検知されていない場合は“0”の値を持ちます。
regDatetime Hash値が登録された時間です。

File Filter

inputFile

APIリクエストの構成

API URL + 分析対象のファイル + 圧縮パスワード + AUTHPARMS

項目 説明
API URL NAVERクラウドプラットフォームFile Safer (File Filter) API URL
https://filesafer.apigw.ntruss.com/filefilter/v1/inputFile
転送方式 POST
リクエストのフォーマット Multipart-form
分析対象のファイル POSTリクエストのBodyにfileを追加します。
hashType hashcodeのアルゴリズム区分であり、MD5, SHA-1をサポートします。
AUTHPARMS x-ncp-apigw-timestamp={timestamp}
x-ncp-apigw-api-key={apiKey}
x-ncp-iam-access-key={accesskey}
x-ncp-apigw-signature-v2={signature}

APIリクエストヘッダ

リクエストヘッダはKey, Valueのセットで構成されており、次の値を持つことができます。

名前(Key) タイプ 説明
file File 分析リクエスト対象のファイル(転送対象のファイル)
archivePassword String 圧縮パスワード

APIリクエストのSample

curl -X POST "https://filesafer.apigw.ntruss.com/filefilter/v1/inputFile"
   -H "accept: application/json"
   -H "Content-Type: multipart/form-data"
   -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
   -d {"archivePassword":{password},"file":{binary}}

APIレスポンスのフォーマット

JSON形式のフォーマットをサポートします。

区分 レスポンスの例題
転送成功 {
    "returnCode": "0",
    "returnMessage": "success"
}
転送失敗 {
    "returnCode": "9",
    "returnMessage": “fail"
}

APIレスポンスの構成

項目 説明
returnCode リクエストに対する処理結果のコードです。
returnMessage リクエストに対する処理結果のメッセージです。

getInputFileLog

APIリクエストの構成

API URL + Hash値 + Hashアルゴリズム区分 + AUTHPARMS

項目 説明
API URL NAVERクラウドプラットフォームFile Safer (File Filter) API URL
https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog
転送方式 GET / POST
リクエストのフォーマット POST転送の場合、Multipart-formを利用します。
アクション File Filterは分析結果の確認のためにgetInputFileLogアクションを提供します。
アクションパラメータ Hash値を指定するhashパラメータとHashアルゴリズムを指定するhashTypeパラメータをサポートします。
AUTHPARMS x-ncp-apigw-timestamp={timestamp}
x-ncp-apigw-api-key={apiKey}
x-ncp-iam-access-key={accesskey}
x-ncp-apigw-signature-v2={signature}

APIリクエストヘッダ

アクションヘッダはKey, Valueのセットで構成されており、次の値を持つことができます。

名前(Key) タイプ 説明
hash String ハッシュ値
hashType String md5, sha1

APIリクエストのSample

(GET)
curl -X GET "https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog?hash=f093e7767bb63ac973b697d3fd1d40a78b87b8bf&hashType=sha1"
   -H "accept: application/json"
   -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

(POST)
curl -X POST "https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog"
   -H "accept: application/json"
   -H "Content-Type: application/json"
   -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
   -d "{ \"hashType\": \"sha1\", \"hash\": \"f093e7767bb63ac973b697d3fd1d40a78b87b8bf\"}"

APIレスポンスのフォーマット

JSON形式のフォーマットをサポートします。

区分 レスポンス
分析されたファイルがある場合 {
    "returnCode": "0",
    "returnMessage": "success",
    "inputFileLogList": [
        {
            "fileType": "application/octet-stream",
            "fileSize": 740544,
            "md5": "a69acb01b99959efec7c0a2a8caa7545",
            "sha1": "f093e7767bb63ac973b697d3fd1d40a78b87b8bf",
            "analysisStatusCode": "CMPL",
            "analysisResultCode": "N",
            "notifyYmdt": null,
            "registrationYmdt": "1548321839000"
        }
    ]
}
分析されたファイルがない場合 {
    "returnCode": "0",
    "returnMessage": "success",
    "inputFileLogList": []
}

APIレスポンスの構成

項目 説明
returnCode リクエストに対する処理結果のコードです。
returnMessage リクエストに対する処理結果のメッセージです。
inputFileLogList リクエストしたHashに該当する検知件に関する情報であり、同じHashのファイルが2回以上分析された場合、リストで表記されます。
fileType 分析されたファイルのフォーマットであり、MIMEの形で表記されます。
fileSize 分析されたファイルのサイズです。
md5 分析されたファイルのMD5 Hash値です。
sha1 分析されたファイルのSHA-1 Hash値です。
analysisStatusCode 分析のステータスコードです。次の値を持ちます。

[ Code : Desc : Status ]
IPRG : Analyzing : 分析中
CMPL : Analysis completed : 分析完了
ERR : Analysis error : エラー
EXCN : Exclude analysis : 例外
analysisResultCode 分析結果のコードです。次の値を持ちます。

[ Code : Desc : Status ]
M : Malware detected : 悪意のあるコード(Hash Filterにアップデートされます。)
N : Malware not detected : 正常なファイル
E : Detection error : エラー
notifyYmdt 通知設定を行った場合、通知が送信された時間です。
registrationYmdt ファイルが入り込まれた時間です。

レスポンスコード

APIリクエストに対する処理結果をレスポンスとして転送し、レスポンスコードはFile SaferによるレスポンスとAPI Gatewayによるレスポンスに区分されます。

File Saferでリクエストが処理された場合のレスポンスコードであり、140000番系列のreturnCodeはエラーが発生した場合です。

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

File Saferで使用する、API Gatewayでエラーが発生した場合のエラーコードです。

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

ご参考

本商品はグローバルリージョンサービスとしても提供されます。

関連情報を確認する

次のガイドで関連情報を確認できます。

に対する検索結果は~件です。 ""

    に対する検索結果がありません。 ""

    処理中...