API

Jay Guard предоставляет API для обращения к функциям продукта по протоколу HTTP и интеграции его возможностей в сторонние приложения.

Доступные методы

Метод	Назначение	Документация
POST /api/dataguard/public/user-masking/mask	Маскирование сущностей в тексте.	Подробнее
POST /api/dataguard/public/user-masking/unmask	Демаскирование сущностей.	Подробнее
POST /api/dataguard/public/audit/list	Экспорт событий аудита.	Подробнее
POST /api/dataguard/public/audit/details	Экспорт детальной информации событий аудита по их идентификаторам.	Подробнее
POST /api/dataguard/public/{serviceName}/{proxyPath}	Проксирование запросов напрямую к языковым моделям. Можно отправлять запросы к моделям: OpenAI; GigaChat; YandexGPT; моделям, размещенным в Caila, например Claude.	Подробнее

Токен для доступа к API

Чтобы отправлять API-запросы, вам нужно сгенерировать токен доступа:

1. Перейдите в раздел Ключи доступа в Jay Guard и нажмите Создать ключ.

2. Введите название ключа и выберите его тип:

   • Для API — если вы планируете использовать ключ для экспорта событий аудита.

     предупреждение

     Вы можете использовать этот ключ также для фильтрации данных при отправке запросов в LLM. Если вы планируете это делать, выберите фильтры для ключа. Иначе запросы будут обрабатываться без фильтрации.

   • Для фильтрации — если вы планируете использовать ключ для других методов. В этом случае вам нужно будет указать фильтры для ключа.

3. Укажите срок окончания действия ключа, если нужно.

4. После создания ключа вы увидите его в списке. Скопируйте и сохраните ключ.