ENСканировать

// REST API

REST API

Тот же движок, что и веб-интерфейс: загрузка сборки, опрос статуса, находки с доказательствами и публичной ссылкой на отчёт. 83 семейства секретов, MASVS, CVSS, SBOM.

АУТЕНТИФИКАЦИЯ

Два вида ключей

Ключ v1 (apk_live_…) передаётся как Bearer-токен. Проще всего для ручных вызовов и старых интеграций.

curl https://apksonar.com/api/v1/scans/42 \
  -H 'Authorization: Bearer apk_live_…'

Ключ v2 (пара apk_mcp_… + secret) подписывает каждый запрос HMAC-SHA256: время с окном ±300 секунд, одноразовый nonce, подпись по методу и пути. Секрет не покидает вашу машину. Именно так работают CLI и MCP-сервер.

signing_key = sha256_hex(secret)
payload   = ts + "\n" + nonce + "\n" + method + " " + path + query
signature = hmac_sha256_hex(signing_key, payload)
curl -X POST https://apksonar.com/api/v1/scans \
  -H "x-apk-key: $APKSONAR_KEY_ID" \
  -H "x-apk-ts: $TS" \
  -H "x-apk-nonce: $NONCE" \
  -H "x-apk-signature: $SIG" \
  -F "[email protected]"

ЗАГРУЗКА

Запуск скана

POST multipart form data. Возвращает 201 с id скана.

POST /api/v1/scans

apk

файл, обязательный

.apk .xapk .apks .aab .dex .so, до 200 МБ

mode

строка, опционально

fast (по умолчанию) или deep (+ Ghidra-анализ нативных либ; на крупных приложениях до нескольких десятков минут)

webhook_url

строка, опционально

http(s)-адрес, на который придёт POST по завершении

curl -X POST https://apksonar.com/api/v1/scans \
  -H "Authorization: Bearer $APKSONAR_KEY" \
  -F "[email protected]" \
  -F "mode=fast" \
  -F "webhook_url=https://ci.example.com/hooks/apksonar/7f3a9c"

201 →

{
  "id": 42,
  "mode": "fast",
  "sha256": "9f2b…e01c",
  "report_url": "/r/BCh8dT6Lg3VbLHqXz0ZT70DL",
  "status_url": "/api/v1/scans/42"
}

СТАТУС

Опрос скана

GET возвращает статус, счётчики по severity и ссылку на отчёт. Опрашивайте раз в 5–10 секунд: fast ~15–60 с, deep ~1–3 мин.

GET /api/v1/scans/{id}

curl https://apksonar.com/api/v1/scans/42 \
  -H "Authorization: Bearer $APKSONAR_KEY"

200 →

{
  "id": 42,
  "status": "done",
  "package": "com.example.app",
  "mode": "fast",
  "findings": { "critical": 2, "high": 3, "medium": 1, "low": 0, "info": 0 },
  "total_findings": 6,
  "has_version_diff": true,
  "report_url": "/r/BCh8dT6Lg3VbLHqXz0ZT70DL",
  "created_at": "2026-11-10T14:03:11.284Z",
  "finished_at": "2026-11-10T14:03:49.901Z"
}

ВЕБХУКИ

Push вместо опроса

Если указан webhook_url, по завершении или падении скана мы отправляем POST с JSON (заголовок x-apksonar-event). Относитесь к URL как к секрету: его знает каждый, кто его видит. Используйте секретный сегмент пути.

{
  "event": "scan.completed",
  "scan": {
    "id": 42,
    "status": "done",
    "package": "com.example.app",
    "mode": "fast",
    "findings": { "critical": 2, "high": 3, "medium": 1, "low": 0, "info": 0 },
    "error": null,
    "report_token": "BCh8dT6Lg3VbLHqXz0ZT70DL",
    "report_url": "/r/BCh8dT6Lg3VbLHqXz0ZT70DL"
  }
}

ОШИБКИ

Что значит код

Коды, которые возвращаются вместо тела:

401

нет ключа, неверный ключ, истёк окно времени или потрачен nonce

402

квота тарифа исчерпана или deep недоступен на вашем тарифе (upgrade: true в теле)

404

скан чужого ключа или не существует

413

файл больше 200 МБ

429

больше 30 сканов за час на ключ

ЛИМИТЫ

Числа, о которых спрашивают

Ограничения на ключ и загрузку:

30 сканов / час / ключ

дальше HTTP 429

максимальный файл

200 МБ

форматы

.apk .xapk .apks .aab .dex .so

хранение

публичная ссылка на отчёт; сам артефакт удаляется после скана

Как создать ключ →