Docs for our awesome API

Платформа Qugo поддерживает два основных способа приглашения исполнителей:

• Одиночное приглашение — подходит, если вы хотите пригласить конкретного исполнителя вручную по телефону.
• Массовое приглашение через реестр — используется для загрузки списка исполнителей с помощью Excel-файла.

1. Одиночное приглашение исполнителя

• Метод: POST /api/v1/employees Отправляет исполнителю СМС с ссылкой для регистрации на платформе. При необходимости можно сразу присвоить исполнителю теги для дальнейшего поиска.
• Метод: GET /api/v1/employees/page Позволяет получить список уже приглашённых исполнителей с возможностью фильтрации по ФИО, номеру телефона, ИНН, тегам и другим признакам. Удобен для поиска по базе и проверки статусов (например, зарегистрирован ли исполнитель).

2. Массовое приглашение исполнителей

Если вы хотите пригласить сразу много исполнителей:

Шаг 1. Подготовьте Excel-файл

Скачайте шаблон приглашения. Укажите:

• номер телефона исполнителя (обязательно),
• опционально — имя и теги для удобства идентификации.

Шаг 2. Загрузите реестр

• Метод: POST /v1/workman-registries Система обработает реестр, отправит приглашения и вернёт информацию об успешных и ошибочных строках.

Шаг 3. Отслеживайте статус загрузки

• Метод: GET /v1/workman-registries Возвращает список всех загруженных реестров, включая дату загрузки, тип (регистрация / приглашение), и статистику по обработке (успешно / с ошибками).

Шаг 4 (опционально). Проверяйте ошибки и отдельные строки

• Получение ошибок: GET /v1/workman-registries/{id}/failed — скачайте Excel с расшифровкой ошибок по каждой строке (например, неверный формат номера).
• Просмотр отдельных элементов: GET /v1/workman-registries/{id}/items — получите детальную информацию по каждому исполнителю в реестре: ФИО, ИНН, телефон, статус обработки.