API ドキュメント
REST API で診断を作成し、結果とレポートを取得します。
認証
Authorization: Bearer <API_KEY> ヘッダーを使用します。キーを公開しないでください。
ダッシュボード → 設定 → API キーでキーを作成します。
curl -H "Authorization: Bearer YOUR_API_KEY" https://issafesite.com/api/v1/scanベース URL
https://issafesite.com/api/v1利用制限
無料: 1日3スキャン、毎分10リクエスト。Pro: 1日50スキャン、毎分60リクエスト。Team: スキャン無制限、毎分300リクエスト。
| プランの詳細 | 1日あたりの診断 | 毎分リクエスト |
|---|---|---|
| Free | 3 | 10 |
| Pro | 50 | 60 |
| Team | ∞ | 300 |
エンドポイント
POST /api/v1/scan で診断を作成し、GET /api/v1/scan で一覧を取得します。GET /api/v1/report でレポートを取得します。
POST /api/v1/scan
POST の本文には url が必須です。depth は QUICK、STANDARD（既定）、DEEP。一覧には page（既定1）、limit（既定20、最大50）を指定でき、レポートは scanId で絞り込めます。
curl -X POST https://issafesite.com/api/v1/scan \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com","depth":"STANDARD"}'202 · 作成済み
GET /api/v1/scan
パラメータ: ページ=1, 件数=20 (≤50)
curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/scan?page=1&limit=10"GET /api/v1/report
パラメータ: scanId, ページ, 件数
curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/report?scanId=clx1abc"エラー応答
スキャン作成は202、一覧は200です。エラーは error フィールドを持つ JSON で、401 はキーなし、403 は無効または期限切れのキーです。
{ "error": "..." }| 400 | パラメータが不足または無効 |
| 401 | API キーがありません |
| 403 | キーが無効または期限切れ |
| 429 | 制限またはプラン枠を超過 |
| 500 | サーバー内部エラー |
クイックスタート
REST API で診断を作成し、結果とレポートを取得します。
curl -X POST https://issafesite.com/api/v1/scan \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com","depth":"STANDARD"}'サポート
プランの利用上限を確認してください。失敗時は HTTP ステータスと JSON 応答で認証、入力、レート制限を確認します。
support@issafesite.com