概要
Web Security Checker APIは RESTful形式で提供され、その APIを呼び出すには Sub Account(サブアカウント)の作成と Access Keyが必要です。
Web Security Checkerの共通設定
Web Security Checker APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです
https://wsc.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名 |
Content-Type |
Required | リクエストデータの形式
|
レスポンス
共通レスポンス形式を説明します
レスポンスステータスコード
レスポンスステータスコードは次の通りです。
| HTTPステータスコード | コード | メッセージ |
|---|---|---|
| 200 | 0 | success |
| 400 | 901 | API Call Fail |
| 401 | 169201 | Auth Check Error |
| 400 | 169202 | User Check Error |
| 400 | 160331 | ActionURL Check Error |
| 400 | 160332 | Param Check Error |
| 400 | 160351 | Login_Check_Fail |
| 400 | 160353 | URL Connection Error |
| 400 | 160431 | Param Check Error |
| 400 | 160432 | Param Check Null |
| 400 | 160433 | Param Value Not Define |
| 400 | 160441 | DB Execute Query Error |
| 400 | 160451 | Assets_Check_Fail |
| 400 | 160452 | Queue_Full |
| 400 | 160453 | Already_Exists |
| 400 | 160454 | TooMany_Insert |
| 400 | 160455 | ReScan Create failed |
| 400 | 160456 | Managed Service agree chk failed |
| 400 | 160457 | Managed Service file chk failed |
| 400 | 160701 | Open period expired |
| 400 | 160842 | DB Matcing Data 0 |
| 400 | 165244 | DB Data Record CNT Not Matching |
参考
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
Web Security Checker API
Web Security Checkerサービスで提供する APIの説明は次の通りです。
| Service | API | Method | Request URI |
|---|---|---|---|
| Web Security Checker | getJobs | GET | https://wsc.apigw.ntruss.com/api/v1/jobs |
| Web Security Checker | searchJobs | POST | https://wsc.apigw.ntruss.com/api/v1/jobs/search |
| Web Security Checker | cancelJob | PATCH | https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/cancel |
| Web Security Checker | stopJob | PATCH | https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/stop |
| Web Security Checker | getReport | GET | https://wsc.apigw.ntruss.com/api/v1/jobs/report |
| Web Security Checker | createJob | PUT | https://wsc.apigw.ntruss.com/api/v1/job |