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-запросы, вам нужно сгенерировать токен доступа:
-
Перейдите в раздел Ключи доступа в Jay Guard и нажмите Создать ключ.
-
Введите название ключа и выберите его тип:
-
Для API — если вы планируете использовать ключ для экспорта событий аудита.
предупреждениеВы можете использовать этот ключ также для фильтрации данных при отправке запросов в LLM. Если вы планируете это делать, выберите фильтры для ключа. Иначе запросы будут обрабатываться без фильтрации.
-
Для фильтрации — если вы планируете использовать ключ для других методов. В этом случае вам нужно будет указать фильтры для ключа.
-
-
Укажите срок окончания действия ключа, если нужно.
-
После создания ключа вы увидите его в списке. Скопируйте и сохраните ключ.