Skip to content

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

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

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

{
  "success": true,
  "message": "...",

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

Где:

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

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

  • invalid_body - тело запроса не прошло валидацию или нарушает бизнес-правила
  • unauthorized - отсутствует или невалиден JWT / refresh token
  • not_found - ресурс не найден
  • conflict - запрос корректен по форме, но конфликтует с текущим состоянием ресурса
  • object_modified_by_another_thread - объект был изменён другой параллельной операцией; клиент должен перечитать актуальное состояние и повторить запрос
  • action_too_late - действие запрещено по бизнес-правилу минимального времени до начала события
  • too_many_request - превышен лимит запросов
  • code_is_gone - одноразовый код истёк или больше не действителен
  • forbidden - у пользователя нет доступа к ресурсу
  • salon_permission_denied - у участника салона нет permission для запрошенного endpoint
  • geocoding_failed - адрес услуги или мастера передан, но backend не смог получить для него координаты
  • address_suggestions_failed - backend не смог получить подсказки адресов от внешнего сервиса
  • invalid_captcha - captcha отсутствует, невалидна или не прошла проверку
Download OpenAPI description
OPENAPI.json
OPENAPI.yaml
Languages
Servers
https://felmee.com
http://localhost:8080