Управление доступом к API. Аутентификация

Аутентификация

API для интеграции относится к публичным API-запросам и не требует аутентификации с использованием Bearer-токена.

Управление доступом к API через IP-адрес

Для обеспечения безопасности и ограничения доступа к API используется механизм белого списка IP-адресов. Администраторы могут управлять этим списком с помощью Artisan команды ip-access:manage. Эта команда предоставляет инструменты для добавления, просмотра и очистки IP-адресов или подсетей, разрешенных для различных типов доступа к API.

Синтаксис команды:
php artisan ip-access:manage {type} {ip?} {--fresh} {--show}
Где:

{type} – обязательный аргумент, определяющий тип доступа, для которого осуществляется управление белым списком. Допустимые значения определены в константе App\Models\IpAccess::TYPES и включают:
- admin
- push1st
- orchestrator
- ib
- integration_module
- billing
- analytic_video
{ip?} – опциональный аргумент, представляющий IP-адрес или подсеть, которую необходимо добавить в белый список. Подсеть указывается в формате IP/маска (например, 192.168.1.0/24). Если этот аргумент не указан, команда не будет добавлять новый IP-адрес.
--fresh – опциональный флаг. При его использовании текущий белый список для указанного типа доступа будет полностью очищен перед добавлением нового IP-адреса (если он указан).
--show – опциональный флаг. При его использовании отображается текущий белый список IP-адресов и подсетей, настроенных для указанного типа доступа.

Примеры использования

Просмотр белого списка для типа billing:
php artisan ip-access:manage billing --show

Добавление IP-адреса 192.168.1.100 для типа billing:
php artisan ip-access:manage billing 192.168.1.100

Добавление подсети 192.168.1.0/24 для типа billing с очисткой списка:
php artisan ip-access:manage billing 192.168.1.0/24 --fresh

Принцип работы

Применение команды ip-access:manage позволяет администраторам точно контролировать, какие IP-адреса или диапазоны IP-адресов имеют право доступа к защищенным API-маршрутам. Механизм промежуточной проверки (middleware) защищает систему, проверяя IP-адрес входящего запроса по белому списку, предназначенному для данного типа доступа.

При попытке доступа к защищенному API-маршруту с IP-адреса, отсутствующего в белом списке для требуемого типа доступа, сервер вернет ошибку HTTP с кодом 403 Forbidden, указывая на отсутствие разрешения на доступ к ресурсу.