Периметр
ВойтиПопробовать бесплатно
ЛИСТ API-00 · REST API
ИНТЕРФЕЙС · v1
REST API · OpenAPI 3

REST API для автоматизации безопасности

Полный программный доступ к платформе Периметр. Запускайте сканирования, управляйте активами и получайте результаты через API.

Открыть Swagger UIБыстрый старт
ЛИСТ API-01 · ВОЗМОЖНОСТИ
СПЕЦИФИКАЦИЯ

Возможности API

API-F-01

JWT-аутентификация с refresh-токенами

API-F-02

Ролевой доступ (Владелец, Администратор, Наблюдатель)

API-F-03

RESTful архитектура с JSON

API-F-04

Запуск сканирований и мониторинг

API-F-05

Экспорт отчётов (PDF, CSV, JSON)

API-F-06

OpenAPI 3.0 спецификация

ЛИСТ API-02 · БЫСТРЫЙ СТАРТ
3 ШАГА

Быстрый старт

Три шага для начала работы с API

01Получите токен

Отправьте POST-запрос с email и паролем для получения JWT-токена.

curl -X POST https://perimeter-scan.ru/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "your_password"
  }'

02Получите ответ с токеном

Сервер вернёт accessToken (15 мин) и refreshToken для обновления.

{
  "user": {
    "id": "uuid",
    "email": "user@example.com",
    "firstName": "John"
  },
  "tokens": {
    "accessToken": "eyJhbG...",
    "refreshToken": "eyJhbG...",
    "expiresIn": 900
  }
}

03Используйте API

Передавайте токен в заголовке Authorization и ID организации в x-organization-id.

curl https://perimeter-scan.ru/api/v1/projects \
  -H "Authorization: Bearer eyJhbG..." \
  -H "x-organization-id: org-uuid"
Важно: accessToken действует 15 минут. Используйте refreshToken для получения нового через POST /api/v1/auth/refresh.
ЛИСТ API-03 · ЭНДПОИНТЫ
СПРАВОЧНИК

Основные эндпоинты

Ключевые endpoints API. Полный список доступен в Swagger UI.

МетодЭндпоинтОписание
POST/api/v1/auth/loginАвторизация и получение JWT-токена
POST/api/v1/auth/registerРегистрация нового пользователя
GET/api/v1/projectsСписок проектов организации
GET/api/v1/assetsСписок активов (домены, IP, URL)
POST/api/v1/scanningЗапуск нового сканирования
GET/api/v1/findingsОбнаруженные уязвимости
GET/api/v1/scores/projects/:idБаллы безопасности проекта
GET/api/v1/modulesДоступные модули сканирования

Готовы интегрировать?

Изучите полную документацию API или создайте аккаунт для получения доступа

Swagger UIСоздать аккаунт

Мы используем файлы cookie для обеспечения работоспособности сервиса и улучшения качества обслуживания. Продолжая использовать сайт, вы соглашаетесь с политикой конфиденциальности.