Спецификация OpenAPI и Swagger UI

Corexar предоставляет полную интерактивную спецификацию всех API-эндпоинтов системы:

  • /api-docs/swagger — Интерактивный интерфейс Swagger UI с возможностью выполнения запросов прямо из браузера
  • /api-docs/swagger.json — Машиночитаемый манифест OpenAPI 3.1.0 для генерации SDK, клиентских библиотек и контрактов

Персональные API-ключи

API-ключи позволяют внешним скриптам, CI/CD-пайплайнам и AI-ассистентам безопасно обращаться к коллекциям от вашего имени с сохранением ролевой модели:

cURL
# Example: Fetching collections via API key
curl -s -H "Authorization: Bearer cxk_live_a89f2e71..." \
  https://corexar.example.com/api/projects

Протокол Model Context Protocol (MCP)

Встроенный MCP-сервер позволяет LLM-агентам (Claude Desktop, Cursor, Google Antigravity, Cline) исследовать коллекции, находить нужные карточки, читать поля и вносить изменения:

claude_desktop_config.json
{
  "mcpServers": {
    "corexar": {
      "command": "node",
      "args": ["/path/to/corexar/mcp-server/index.mjs"],
      "env": {
        "COREXAR_URL": "https://corexar.example.com",
        "COREXAR_API_KEY": "cxk_your_key_here"
      }
    }
  }
}

Доступные инструменты MCP

  • corexar_get_profile — Проверка профиля, доступных воркспейсов и прав текущего ключа
  • corexar_list_projects — Получение списка коллекций рабочей области со схемами полей
  • corexar_get_collection_schema — Детальная схема коллекции, воркфлоу-статусы и настройки представлений
  • corexar_search_items — Полнотекстовый и фасетный поиск по коллекциям и карточкам
  • corexar_create_item — Создание новой записи с валидацией полей и правил доступа
  • corexar_update_item_fields — Точечное обновление значений полей карточки