Personal Workspace

Введение

Аутентификация и безопасность

Исполнители

Получение списка исполнителей, доступных заказчику.

Приглашение нового исполнителя в систему.

Приглашение исполнителя к заданию по ИНН.

Приглашение исполнителя к заданию по телефону.

Получение списка реестров приглашения исполнителей.

Выгрузка файла с ошибочными записями в реестре приглашений.

Получение элементов из реестра приглашений.

Задания

Получение списка всех заданий.

Создание задания.

Получение информации о задании по ID.

Отмена задания.

Получение шаблона реестра заданий.

Загрузка реестра заданий.

Получение информации о реестре заданий.

Получение элементов из реестра заданий.

Выгрузка файла с ошибочными записями реестра заданий.

Массовое завершение заданий.

Выплаты

Получение шаблона реестра для выплат.

Получение справочника с названиями услуг.

Получение списка реестров выплат.

Получение списка выплат с постраничным отображением.

Формирование реестра выплат с одним элементом.

Формирование реестра выплат (из данных запроса).

Оплата реестра по ID.

Получение списка элементов реестра выплат.

Выгрузка файла с ошибочными записями реестра выплат.

Баланс

Получение истории зачислений на счет.

Получение баланса заказчика.

Начисление денежных средств на счет.

Документы

Получение закрывающих актов.

Получение списка договоров с постраничным отображением.

Default

Qugo

Production

integration

Sandbox

<h3 class="slate-h3 " >Описание и возможности API:</h3><p class="slate-p " >Документация упрощает API интеграции с платформой Qugo и автоматизацию бизнес-процессов компании. Методы API разделены на категории: Исполнители, Задания, Выплаты, Баланс и Документы, что облегчает навигацию и использование.</p><h2 class="slate-h2 " ><strong class="slate-bold">Ключевые понятия и термины</strong>:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">Account (Заказчик)</strong></em> — пользователь платформы, который публикует задания и устанавливает вознаграждение за их выполнение.</div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">Workman (Исполнитель)</strong></em> — внештатный сотрудник, выполняющий задания и получающий за это оплату.</div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">Job (Задание</strong></em>) — сущность, создаваемая заказчиком. Это работа, которую нужно выполнить за вознаграждение. Обладает параметрами: описание задания, срок выполнения и бюджет.</div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">JobOffer (Предложение по заданию\отлик)</strong></em> — предложение исполнителя с суммой, за которую он возьмётся за исполнение.</div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">JobInvite (Приглашение на задание)</strong></em> <em class="slate-italic">—</em> Приглашение к исполнению задания, которое заказчик отправляет исполнителю. Приглашение приходит в виде ссылки в СМС-сообщении и в виде уведомлении на платформе. Исполнитель может принять или отклонить приглашение.</div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">Payroll Registry —</strong></em> Реестр выплат, <em class="slate-italic"><strong class="slate-bold">через который в QUGO создаются задания с упрощенным жизненным циклом.</strong></em></div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic"><strong class="slate-bold">Employee (Избранный исполнитель) —</strong></em> <em class="slate-italic">Исполнитель или будущий ещё не зарегистрированный исполнитель, который имел отношение к заказчику в рамках сервиса QUGO. Избранным он становится по следующему ряду причин:
1. </em>Был приглашен в сервис через интерфейс или через методы API
2. Успешно выполнил задание, созданное заказчиком.
3. Зарегистрировался в сервисе по реферальной ссылке заказчика.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Выплаты</strong> — транзакции за выполненные задания.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Баланс</strong> — номинальный счет заказчика, используемый совершения выплат.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Документы</strong> — документация, необходимая для отчетности и организации процесса выплат.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Возможности API</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Приглашать исполнителей и запрашивать информацию о зарегистрированных исполнителях</div></li><li class="slate-li " ><div style="position:relative">Запрашивать информацию о договорах, персональных документах исполнителей</div></li><li class="slate-li " ><div style="position:relative">Создавать задания для исполнителей</div></li><li class="slate-li " ><div style="position:relative">Формировать реестры на выплаты, оплачивать выполненные задания</div></li><li class="slate-li " ><div style="position:relative">Создавать акты и запрашивать информацию о созданных на платформе актах</div></li><li class="slate-li " ><div style="position:relative">Работать со номинальным счетом на платформе: запрашивать выписки, историю пополнений счета</div></li></ul><h2 class="slate-h2 " ><strong class="slate-bold">Ограничения и лимиты запросов</strong>:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">1000 запросов в секунду</div></li></ul><h2 class="slate-h2 " ><strong class="slate-bold">Данные и методы</strong>:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">API поддерживает методы <strong class="slate-bold">GET</strong> и <strong class="slate-bold">POST</strong>. Все запросы и ответы передаются в формате JSON, что обеспечивает совместимость с большинством языков программирования.</div></li></ul><h2 class="slate-h2 " ><strong class="slate-bold">Структура ошибок</strong>:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">API возвращает стандартные коды ошибок HTTP: 4xx для клиентских ошибок, 5xx для серверных</div></li></ul><p class="slate-p " ></p>

Описание и возможности API:

Документация упрощает API интеграции с платформой Qugo и автоматизацию бизнес-процессов компании. Методы API разделены на категории: Исполнители, Задания, Выплаты, Баланс и Документы, что облегчает навигацию и использование.

Ключевые понятия и термины

Ограничения и лимиты запросов

<p class="slate-p " ></p><h3 class="slate-h3 " >Получение API токена:</h3><p class="slate-p " >API токен необходим для авторизации при взаимодействии с API. Токен выполняет роль уникального ключа, который позволяет системе идентифицировать и проверить права доступа клиента. Без токена запросы к API будут отклонены и пользователь получит соответствующую ошибку. (код 401 Error: Unauthorized).</p><h3 class="slate-h3 " >Процесс получения токена:</h3><p class="slate-p " >Пользователь запрашивает токен у бота технической поддержки в специальном чате Telegram. Поддержка отправляет токен.</p><h3 class="slate-h3 " >Использование токена</h3><p class="slate-p " >В каждом запросе токен передаётся в заголовке Authorization: Bearer YOUR_TOKEN (посл Bearer ставится [пробел]).</p><p class="slate-p " ></p>

API токен необходим для авторизации при взаимодействии с API. Токен выполняет роль уникального ключа, который позволяет системе идентифицировать и проверить права доступа клиента. Без токена запросы к API будут отклонены и пользователь получит соответствующую ошибку. (код 401 Error: Unauthorized).

Процесс получения токена:

Пользователь запрашивает токен у бота технической поддержки в специальном чате Telegram. Поддержка отправляет токен.

В каждом запросе токен передаётся в заголовке Authorization: Bearer YOUR_TOKEN (посл Bearer ставится [пробел]).

Sections

Аутентификация и безопасность

Получение API токена:

Процесс получения токена:

Использование токена

On this page