Руководство / API и AI-агенты

API-ключи и документация Swagger

Создание персональных ключей доступа и исследование интерактивной документации эндпоинтов.

Corexar предоставляет полноценный REST API для чтения, создания и изменения коллекций, карточек и связей.

Интерактивный Swagger UI

По адресу /api-docs/swagger доступна интерактивная документация, где можно ознакомиться со всеми эндпоинтами и выполнить тестовые запросы прямо из браузера.

Интерфейс Swagger UI с интерактивным тестированием эндпоинтов

Управление API-ключами

В настройках профиля или панели администратора можно выпустить персональный токен с префиксом cxk_. Ключ наследует права вашей роли.

Уровень доступаВозможностиРекомендуется для
Полный доступЧтение, создание, редактирование и удаление записейCI/CD-пайплайны и доверенные агенты
Только чтениеПоиск и получение записей без возможности измененияАудит и аналитические скрипты
ВыборочныйОграничение доступа отдельными коллекциямиИнтеграции со сторонними сервисами
Совет. Никогда не публикуйте ключи доступа в открытых репозиториях. При компрометации ключ можно отозвать в один клик.