Skip to content

Внутреннее API Felmee (0.0.14)

Общий формат ответа

Все REST-эндпоинты возвращают ответ в едином формате:

  "success": false,
  "message": "...",

  "codeError": null,
  "error_code": null,
  "data": {}  }

Где:

  • success - флаг успешного выполнения запроса
  • message - человекочитаемое описание результата
  • codeError - legacy-alias поля error_code; при ошибке содержит тот же код, при успехе null
  • error_code - машинный код ошибки; для успешных ответов всегда null
  • data - полезная нагрузка; может быть объектом, массивом или null

Готовность вложений

Перед привязкой загруженных файлов к сообщениям, услугам, профилям, категориям, блогам, отзывам, жалобам, обращениям и документам регистрации требуется UPLOADED. PENDING, FAILED и отсутствующие файлы не принимаются. Проверки владельца, доступа, назначения и типа файла сохраняются. Это относится и к замене вложений. Успешный ответ POST /api/file/upload гарантирует полную подготовку и локальную запись файла, включая предусмотренные оригинал и preview. Полученный file_id можно сразу прикреплять. Обычные сообщения REST/WS с неготовыми файлами отклоняются с file_not_ready (REST: HTTP 409). Остальные операции сохраняют существующие ошибки валидации. Создание услуги сохраняет ожидание готовности до 5 секунд и ошибки file_upload_failed / file_upload_timeout.

Возможные значения error_code

  • invalid_body - тело запроса не прошло валидацию или нарушает бизнес-правила
  • unauthorized - отсутствует или невалиден JWT / refresh token
  • not_found - ресурс не найден
  • slot_unavailable - выбранное время записи больше недоступно (в том числе POST /api/record/create/approve/{id} возвращает HTTP 409)
  • conflict - запрос корректен по форме, но конфликтует с текущим состоянием ресурса
  • BUSINESS_INACTIVE - при выводе статус бенефициара по ИНН подтверждён как неактивный
  • INSUFFICIENT_FUNDS - недостаточно доступных средств для вывода
  • REQUISITES_REQUIRED - для вывода нет сохранённых реквизитов
  • IDEMPOTENCY_KEY_REUSED - ключ повторно использован с другим телом запроса
  • REGISTRY_UNAVAILABLE - актуальный статус по ИНН временно не удалось проверить
  • BENEFICIARY_NOT_READY - нет единственного подтверждённого бенефициара
  • BANK_ACCOUNT_UNAVAILABLE - стандартный виртуальный счёт отсутствует
  • BANK_UNAVAILABLE - интеграция с банком временно недоступна
  • object_modified_by_another_thread - объект был изменён другой параллельной операцией; клиент должен перечитать актуальное состояние и повторить запрос
  • member_deletion_already_scheduled - удаление участника салона уже запланировано
  • member_deletion_blocked - удаление участника салона заблокировано текущим состоянием
  • member_already_active - участник салона уже активен
  • member_restore_window_expired - срок восстановления участника салона истёк
  • member_reactivation_not_allowed - повторная активация участника салона запрещена
  • action_too_late - действие запрещено по бизнес-правилу минимального времени до начала события
  • too_many_request - превышен лимит запросов
  • code_is_gone - одноразовый код истёк или больше не действителен
  • forbidden - у пользователя нет доступа к ресурсу
  • user_blocked - пользователь заблокирован
  • salon_permission_denied - у участника салона нет permission для запрошенного endpoint
  • geocoding_failed - адрес услуги или мастера передан, но backend не смог получить для него координаты
  • file_not_ready - вложения сообщения ещё загружаются, загрузились с ошибкой или больше не существуют; сообщение не создано
  • conflicting_geo_filters - одновременно переданы несовместимые географические фильтры
  • address_suggestions_failed - backend не смог получить подсказки адресов от внешнего сервиса
  • invalid_captcha - captcha отсутствует, невалидна или не прошла проверку
  • invite_code_not_found - код приглашения не найден
  • admin_account_not_found - учётная запись администратора не найдена
  • record_not_found - запись не найдена
  • record_not_cancelable - запись нельзя отменить в текущем состоянии
  • feed_expired - срок действия выдачи рекомендаций истёк
  • feed_busy - выдача рекомендаций временно занята другим запросом
  • file_upload_failed - upload не завершил подготовку или запись файла (HTTP 500); для создания услуги сохраняется HTTP 422 при FAILED
  • file_upload_timeout - создание услуги не дождалось готовности ранее загруженных фото за 5 секунд (HTTP 408)
  • internal_error - внутренняя ошибка сервера
Download OpenAPI description
Languages
Servers
https://felmee.com
http://localhost:8080