Перейти к основному содержимому

API

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

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

Управление файлами в хранилище

МетодНазначениеСпецификация
POST /api/dataguard/public/filesЗагрузка файла в хранилище.Перейти
GET /api/dataguard/public/files/{fileId}Скачивание файла из хранилища.Перейти
DELETE /api/dataguard/public/files/{fileId}Удаление файла из хранилища.Перейти

Маскирование сущностей в файлах

МетодНазначениеСпецификация
PUT /api/dataguard/public/user-masking/storage/maskМаскирование сущностей в файлах, ранее загруженных в хранилище.Перейти
POST /api/dataguard/public/user-masking/files/maskЗагрузка файла в хранилище и запуск маскирования файла.Перейти
GET /api/dataguard/public/user-masking/files/resultПолучение результата маскирования файла.Перейти

Маскирование и демаскирование сущностей в запросах

МетодНазначениеСпецификация
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. После создания ключа вы увидите его в списке. Скопируйте и сохраните ключ.