Получение пользователя

Параметры запроса#

Можно получить полную информацию о правах пользователя или добавить проверку конкретной площадки.

Здесь "AfoninGA" — идентификатор сотрудника в 1С (или внешней системе учёта).

Примеры запроса#

GET /api/v1/users/AfoninGA?site_source_id=WH-SEVER HTTP/1.1
Host: app.zaezdo.pro
Authorization: Bearer ВАШ_API_ТОКЕН
Accept: application/json

GET /api/v1/users/AfoninGA HTTP/1.1
Host: app.zaezdo.pro
Authorization: Bearer ВАШ_API_ТОКЕН
Accept: application/json

curl --request GET \
  --url "https://app.zaezdo.pro/api/v1/users/AfoninGA?site_source_id=WH-SEVER" \
  --header "Authorization: Bearer ВАШ_API_ТОКЕН"

Успешный ответ и права пользователя#

{
  "source_id": "AfoninGA",
  "full_name": "Анна Соколова",
  "is_active": true,
  "has_account": true,
  "roles": [
    {
      "code": "MANAGER",
      "name": "Менеджер",
      "scope": "SELECTED_SITES",
      "sites": [
        {
          "source_id": "WH-SEVER",
          "name": "Склад Север"
        },
        {
          "source_id": "WH-YUG",
          "name": "Склад Юг"
        }
      ]
    },
    {
      "code": "DISPATCHER",
      "name": "Диспетчер",
      "scope": "ALL_SITES",
      "sites": []
    },
    {
      "code": "CHECKPOINT",
      "name": "Сотрудник КПП / охрана",
      "scope": "SELECTED_SITES",
      "sites": [
        {
          "source_id": "WH-SEVER",
          "name": "Склад Север"
        }
      ]
    }
  ],
  "can_be_responsible_for_site": {
    "site_source_id": "WH-SEVER",
    "allowed": true
  }
}

{
  "source_id": "AfoninGA",
  "full_name": "Анна Соколова",
  "is_active": true,
  "has_account": true,
  "roles": [
    {
      "code": "MANAGER",
      "name": "Менеджер",
      "scope": "SELECTED_SITES",
      "sites": [
        {
          "source_id": "WH-SEVER",
          "name": "Склад Север"
        },
        {
          "source_id": "WH-YUG",
          "name": "Склад Юг"
        }
      ]
    },
    {
      "code": "DISPATCHER",
      "name": "Диспетчер",
      "scope": "ALL_SITES",
      "sites": []
    },
    {
      "code": "CHECKPOINT",
      "name": "Сотрудник КПП / охрана",
      "scope": "SELECTED_SITES",
      "sites": [
        {
          "source_id": "WH-SEVER",
          "name": "Склад Север"
        }
      ]
    }
  ]
}

{
  "source_id": "AfoninGA",
  "full_name": "Анна Соколова",
  "is_active": true,
  "has_account": true,
  "roles": [
    {
      "code": "MANAGER",
      "name": "Менеджер",
      "scope": "SELECTED_SITES",
      "sites": [
        {
          "source_id": "WH-SEVER",
          "name": "Склад Север"
        },
        {
          "source_id": "WH-YUG",
          "name": "Склад Юг"
        }
      ]
    },
    {
      "code": "DISPATCHER",
      "name": "Диспетчер",
      "scope": "ALL_SITES",
      "sites": []
    },
    {
      "code": "CHECKPOINT",
      "name": "Сотрудник КПП / охрана",
      "scope": "SELECTED_SITES",
      "sites": [
        {
          "source_id": "WH-SEVER",
          "name": "Склад Север"
        }
      ]
    }
  ],
  "can_be_responsible_for_site": {
    "site_source_id": "WH-SEVER",
    "allowed": false,
    "reason": "MANAGER_NO_SITE_ACCESS"
  }
}

В обоих режимах метод возвращает данные пользователя и все его роли. Если передан site_source_id, в ответ дополнительно включается can_be_responsible_for_site.

Если site_source_id не передан, ответ содержит все те же данные и роли, но объект can_be_responsible_for_site полностью отсутствует.

Поля ответа

Роли и область действия

Роль и доступные ей площадки описываются вместе — это позволяет внешней системе понять фактическое распределение прав.

Поддерживаемые коды ролей:

Возможность назначения ответственным

Проверка выполняется только при наличии параметра site_source_id. Заездо проверяет одновременно:

• сотрудник активен (is_active = true);
• имеет действующую учётную запись (has_account = true);
• ему назначена роль MANAGER;
• роль MANAGER действует на указанной активной площадке.

РЕЗУЛЬТАТ УСПЕШНОЙ ПРОВЕРКИ · ФРАГМЕНТ ОТВЕТА

{
  "can_be_responsible_for_site": {
    "site_source_id": "WH-SEVER",
    "allowed": true
  }
}

ОТКАЗ В НАЗНАЧЕНИИ · ФРАГМЕНТ ОТВЕТА

{
  "can_be_responsible_for_site": {
    "site_source_id": "WH-SEVER",
    "allowed": false,
    "reason": "MANAGER_NO_SITE_ACCESS"
  }
}

Отказ в назначении не является ошибкой HTTP: метод возвращает 200 OK с данными сотрудника и allowed = false.

Порядок проверки запроса#

Проверки выполняются по этапам. При ошибке метод возвращает результат текущего этапа и не переходит к следующему.

Без site_source_id поиск площадки и проверка назначения не выполняются. Пустой переданный site_source_id — это некорректный параметр, а не отсутствие параметра.

Если идентификатор пользователя некорректен, а площадка не существует, сначала возвращается 422. Поиск площадки начнётся только после исправления параметров.

Коды и описания ошибок#

Для HTTP 404 поиск выполнен, но запись не найдена. Для HTTP 422 поиск ещё не выполнялся: сначала нужно исправить параметры.

Пользователь, у которого не заполнен source_id, не может быть найден по идентификатору из 1С. Неактивный пользователь или отключённая площадка считаются найденными: это не основание для 404.

Формат ошибки и примеры

HTTP 404 · НЕ НАЙДЕНЫ ПОЛЬЗОВАТЕЛЬ И ПЛОЩАДКА

{
  "code": "RESOURCE_NOT_FOUND",
  "message": "Не найдены записи по переданным идентификаторам.",
  "errors": [
    {
      "field": "source_id",
      "code": "USER_NOT_FOUND",
      "message": "Пользователь с указанным source_id не найден."
    },
    {
      "field": "site_source_id",
      "code": "SITE_NOT_FOUND",
      "message": "Площадка с указанным site_source_id не найдена."
    }
  ],
  "request_id": "req-123456"
}

Если не найдена только одна запись, errors[] содержит один элемент. Верхнеуровневый code остаётся RESOURCE_NOT_FOUND.

HTTP 422 · НЕКОРРЕКТНЫ ОБА ИДЕНТИФИКАТОРА

{
  "code": "VALIDATION_ERROR",
  "message": "Ошибка проверки параметров запроса.",
  "errors": [
    {
      "field": "source_id",
      "code": "INVALID_SOURCE_ID",
      "message": "Некорректный идентификатор сотрудника."
    },
    {
      "field": "site_source_id",
      "code": "INVALID_SITE_SOURCE_ID",
      "message": "Некорректный идентификатор площадки."
    }
  ],
  "request_id": "req-123457"
}

Что делать при получении ответа

Для программной обработки используйте HTTP-статус и поля code, errors[].field, errors[].code. Покажите пользователю все errors[].message; если массива нет — общий message. Не определяйте тип ошибки по тексту сообщения.

Проверка users не закрепляет права на будущее. При создании визита Заездо проверяет возможность назначения ответственного повторно.

Использование при создании визита#

Например, в 1С (или в другой внешней системе) у контрагента ответственным менеджером указан пользователь с кодом "AfoninGA". Перед созданием визита можно проверить его права на площадке "WH-SEVER".

ПРОВЕРКА ПОЛЬЗОВАТЕЛЯ И ПЛОЩАДКИ

GET /api/v1/users/AfoninGA?site_source_id=WH-SEVER

Если сервер вернул 200 OK и allowed = true, при создании визита передаётся:

ФРАГМЕНТ ЗАПРОСА POST /api/v1/visits

{
  "responsible_user_source_id": "AfoninGA"
}

Заездо назначает указанного сотрудника ответственным за визит. Если сотрудник не может быть назначен, визит не создаётся.