API Документация

Добро пожаловать в техническую документацию по REST API Neuro2Neuro. Наш API позволяет интегрировать возможности нейро эмпатии и психологической поддержки напрямую в ваши системы.

Доступ и Аутентификация

Доступ к Neuro2Neuro API предоставляется клиентам после заключения договора и оформления подписки. Для аутентификации используется API-ключ, который необходимо передавать в заголовке каждого запроса.

Authorization: Bearer YOUR_API_KEY

Ваш уникальный API-ключ будет доступен в личном кабинете после активации подписки. Храните его в безопасности и не передавайте третьим лицам.

Запросить доступ к API

Базовый URL

Все запросы к API следует отправлять на следующий базовый URL:

https://api.neuro2neuro.ru/v1

Примеры Эндпоинтов (Placeholder)

Ниже приведены примеры возможных эндпоинтов для взаимодействия с платформой. Полный список и детальное описание каждого эндпоинта будут доступны в полной версии документации после получения доступа.

POST/profiles/analyze

Отправка профиля кандидата для квантового анализа.

GET/profiles/{profile_id}/report

Получение детального отчета по результатам анализа профиля.

GET/benchmarks/industry/{industry_code}

Получение отраслевых бенчмарков для сравнения профилей.

PUT/settings/integration

Обновление настроек интеграции с внешними системами (например, ATS).

Правила Подключения и Best Practices

Rate Limiting: В целях обеспечения стабильности работы сервиса для всех пользователей, на запросы к API действуют ограничения по частоте (rate limits). Стандартное ограничение - 100 запросов в минуту. При превышении лимита API вернет ошибку 429 Too Many Requests.
Обработка ошибок: Ваше приложение должно корректно обрабатывать возможные ошибки API (например, 4xx для клиентских ошибок и 5xx для серверных). Подробные коды ошибок будут описаны в полной документации.
Версионирование: API использует версионирование через URL (/v1/). Следите за обновлениями API и планируйте миграцию на новые версии при необходимости.
Безопасность: Всегда используйте HTTPS для запросов к API. Никогда не храните API-ключ в открытом виде в клиентском коде.
Формат данных: API принимает и возвращает данные в формате JSON. Убедитесь, что заголовок Content-Type: application/json установлен для POST/PUT запросов.

Потенциальные Методы Подключения

Мы проектируем наш API с учетом современных стандартов и потребностей разработчиков. В будущем возможны следующие варианты взаимодействия:

REST API (Текущий стандарт)

Основной способ интеграции через стандартные HTTP-методы (GET, POST, PUT, DELETE) и JSON. Аутентификация через API-ключи. Идеально подходит для большинства интеграций.

Webhook Уведомления

Webhook-интеграция позволяет вашим системам реагировать на события в Neuro2Neuro в реальном времени без необходимости постоянного опроса (polling).

OAuth 2.0 Аутентификация (В планах)

Для сценариев, где требуется делегированный доступ от имени пользователя (например, для интеграции с маркетплейсами или платформами расширений), может быть внедрена поддержка OAuth 2.0.

GraphQL API (Рассматривается)

Для сложных запросов, где требуется получать только определенные поля данных из нескольких ресурсов одним запросом, мы рассматриваем возможность предоставления GraphQL эндпоинта в будущем.

Остались вопросы по API?

Свяжитесь с нашей командой для получения консультации по интеграции.

Связаться с поддержкой API