REST API
REST API для автоматизации безопасности
Полный программный доступ к платформе Периметр. Запускайте сканирования, управляйте активами и получайте результаты через API.
Возможности API
JWT-аутентификация с refresh-токенами
Ролевой доступ (Владелец, Администратор, Наблюдатель)
RESTful архитектура с JSON
Запуск сканирований и мониторинг
Экспорт отчётов (PDF, CSV, JSON)
OpenAPI 3.0 спецификация
Быстрый старт
Три шага для начала работы с API
1
Получите токен
Отправьте 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"
}'2
Получите ответ с токеном
Сервер вернёт accessToken (15 мин) и refreshToken для обновления.
{
"user": {
"id": "uuid",
"email": "user@example.com",
"firstName": "John"
},
"tokens": {
"accessToken": "eyJhbG...",
"refreshToken": "eyJhbG...",
"expiresIn": 900
}
}3
Используйте 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.
Основные эндпоинты
Ключевые 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 или создайте аккаунт для получения доступа
