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

Обзор API

REST API ArchiCore позволяет интегрировать анализ архитектуры в ваши рабочие процессы.

Базовый URL​

https://api.archicore.io/api/v1

Аутентификация​

Все запросы требуют аутентификации через Bearer token:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.archicore.io/api/v1/projects

См. Аутентификация для получения API-ключей.

Формат ответа​

Все ответы в JSON:

{
  "success": true,
  "data": { ... }
}

Ответы с ошибкой:

{
  "success": false,
  "error": "Сообщение об ошибке",
  "code": "ERROR_CODE"
}

HTTP-коды статуса​

КодОписание
200Успех
201Создано
400Неверный запрос
401Не авторизован
403Доступ запрещён
404Не найдено
429Слишком много запросов
500Внутренняя ошибка сервера

Лимиты запросов​

ТарифЗапросов/деньЗапросов/минуту
Free10010
Pro10,000100
EnterpriseБез лимита1,000

Эндпоинты​

Проекты​

МетодЭндпоинтОписание
GET/projectsСписок проектов
POST/projectsСоздать проект
GET/projects/:idДетали проекта
DELETE/projects/:idУдалить проект
POST/projects/:id/indexЗапустить индексацию

Анализ​

МетодЭндпоинтОписание
POST/projects/:id/searchСемантический поиск
POST/projects/:id/askAI-ассистент
GET/projects/:id/metricsМетрики кода
GET/projects/:id/securityРезультаты сканирования
POST/projects/:id/analyzeАнализ влияния

Вебхуки​

МетодЭндпоинтОписание
GET/webhooksСписок вебхуков
POST/webhooksСоздать вебхук
DELETE/webhooks/:idУдалить вебхук