searchJobs

개요

• searchJobs API 는 "Web Security Checker" 에서 제공하는 기능으로 네이버 클라우드 플랫폼 콘솔에서 사용자가 등록한 진단 리스트를 출력하는 API 입니다.

요청

요청 헤더

IAM 인증을 위한 요청 헤더입니다.

요청 파라미터

요청 바디

{
    "searchType": "url",
    "searchKeyword": "your-domain.com",
    "statusCode": null,
    "limit": 10,
    "page": 1
}

응답

응답 바디

예시

요청 예시

curl -X GET "https://wsc.apigw.ntruss.com/api/v1/jobs/search"
   -H "accept: application/json"
   -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 '{"searchType": "url",
    "searchKeyword": "your-domain.com",
    "statusCode": null,
    "limit": 10,
    "page": 1}'

응답 예시 1

{
    "resources": {
        "total_cnt": 1,
        "total_page_cnt": "1",
        "current_start_page": "1",
        "current_end_page": "10",
        "record_data": [
            {
                "instanceNo": "1234567890",
                "start_date": "2020-05-21 12:00:00",
                "end_date": null,
                "status": "예약",
                "start_url": "http://your-domain.com",
                "crawl_cnt": null,
                "scan_cnt": null,
                "memo": "샘플",
                "result_button": "cancel",
                "result_desc": null,
                "rescan_button": null,
                "slave_data": null
            }
        ]
    }
}

응답 예시 2

{
    "resources": {
        "total_cnt": 0,
        "total_page_cnt": "1",
        "current_start_page": "1",
        "current_end_page": "1",
        "record_data": null
    }
}

샘플 코드

make_signature 함수로 시그니처를 생성하여 요청 헤드를 생성한 후 응답 코드가 200인 경우 등록한 진단 리스트를 출력하는 샘플 코드는 다음과 같습니다.

import sys
import os
import hashlib
import hmac
import base64
import requests
import time

def make_signature(method, uri, timestamp):

    access_key = "{accessKey}"  # access key id (from portal or sub account)
    secret_key = "{secretKey}"  # secret key (from portal or sub account)
    secret_key = bytes(secret_key, 'UTF-8')

    method = method
    uri = uri

    message = method + " " + uri + "\n" + timestamp + "\n" + access_key
    message = bytes(message, 'UTF-8')
    signingKey = base64.b64encode(hmac.new(secret_key, message, digestmod=hashlib.sha256).digest())
    return signingKey

timestamp = str(int(time.time() * 1000))

method = 'POST'
uri = '/api/v1/jobs/search'
payload = {
  "searchType": "url",
  "searchKeyword": "user-domain.co.kr",
  "statusCode": None,
  "limit": 1,
  "page": 1
}

timestamp = str(int(time.time() * 1000))

signature = make_signature(method, uri, timestamp)

headers = {
    'x-ncp-apigw-signature-v2': signature.decode('utf-8'),
    'x-ncp-apigw-timestamp': timestamp,
    'x-ncp-iam-access-key': '{accessKey}' # access key id (from portal or sub account)
}

response = requests.request(
    method,
    f"https://wsc.apigw.ntruss.com{uri}",
    headers=headers,
    data=json.dumps(payload), # Json format required
)

if response.status_code == 200:
    print(response.text)