過去のお知らせ

APIの概要と共通仕様

通信方式
Scutum APIは、Web APIです。プロトコルはHTTPSのみをサポートしています。
インターネットに接続し、HTTPSでの通信が可能なクライアントから利用できます。

APIの呼び出し方法
Scutum APIを利用するには、APIキーが必要です。APIキーの取得方法は以下ページを参照してください。
 →APIキーの管理
APIキーはリクエストヘッダ X-Scutum-API-Key の値として以下のように送信してください。

GET /api/v1/alert?host=www.example.jp&id=ABC1234 HTTP/1.1
Host: api.scutum.jp
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Connection: close

※ FQDN: www.example.jp ユーザID: ABC1234 APIキー: 17a1f5d161b33b6404faa8f8ccfdfdf2edf の場合の呼び出しリクエストの例です。

取得可能なデータの期間
過去1年間のデータが取得対象です。1年以上過去のデータを取得することは出来ません。

呼び出し回数の制限
1つのAPIキーにつき25回/5分の利用回数制限が設けられています。この制限を超えた場合、
APIは429エラーを返します。しばらく待ってから再度実行してください。

レスポンス
APIの呼び出し結果は、JSON形式で返却されます。

ページネーション
一度のAPI呼び出しで取得できるデータ件数の上限は1000件です。 1000件を超える場合は、レスポンスボディ truncated の値が true になります。
さらに1000件のデータを取得するには、レスポンスボディに含まれる next_marker の値をリクエストパラメータ marker に指定してAPIを呼び出してください。

日時のフォーマット
レスポンスに含まれる日時のフォーマットは、 YYYY-MM-DDThh:mm:ss+09:00 です。
※ISO8601の拡張形式に準拠

ステータスコード一覧
API呼び出しエラー時のHTTPステータスコードやエラーメッセージは以下の通りです。

コード エラーメッセージ 説明
400 Invalid Date format 日付のフォーマットが不正、またはURLエンコードされていない
403 X-Scutum-API-Key not found. リクエストヘッダにX-Scutum-API-Keyがない
403 Invalid API key リクエストパラメータX-Scutum-API-Keyhostidのいずれかの値、または組み合わせが不正
429 Too Many Requests 呼び出し回数制限を超過


※レスポンスに含まれるパラメータは、今後の機能拡充で追加・変更になる可能性があります。