ポータルのショートカット NAVERクラウドプラットフォームのマニュアル

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

APIの概要

NAVERクラウドプラットフォーム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の呼び出しの内容をご参考ください。

• IAM認証が必要なAPIの呼び出し

Hash Filter

checkHash

APIリクエストの構成

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

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

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フォーマットをサポートします。

APIレスポンスの構成

File Filter

inputFile

APIリクエストの構成

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

APIリクエストヘッダ

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

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形式のフォーマットをサポートします。

APIレスポンスの構成

getInputFileLog

APIリクエストの構成

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

APIリクエストヘッダ

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

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形式のフォーマットをサポートします。

APIレスポンスの構成

レスポンスコード

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

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

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

ご参考

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

関連情報を確認する

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

• File Safer使用ガイド
• File Safer API開始ガイド
• グローバルリージョン使用ガイド