Введение

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

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

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

• Account (Заказчик) — пользователь платформы, который публикует задания и устанавливает вознаграждение за их выполнение.
• Workman (Исполнитель) — внештатный сотрудник, выполняющий задания и получающий за это оплату.
• Job (Задание) — сущность, создаваемая заказчиком. Это работа, которую нужно выполнить за вознаграждение. Обладает параметрами: описание задания, срок выполнения и бюджет.
• JobOffer (Предложение по заданию\отлик) — предложение исполнителя с суммой, за которую он возьмётся за исполнение.
• JobInvite (Приглашение на задание) — Приглашение к исполнению задания, которое заказчик отправляет исполнителю. Приглашение приходит в виде ссылки в СМС-сообщении и в виде уведомлении на платформе. Исполнитель может принять или отклонить приглашение.
• Payroll Registry — Реестр выплат, через который в QUGO создаются задания с упрощенным жизненным циклом.
• Employee (Избранный исполнитель) — Исполнитель или будущий ещё не зарегистрированный исполнитель, который имел отношение к заказчику в рамках сервиса QUGO. Избранным он становится по следующему ряду причин: 1. Был приглашен в сервис через интерфейс или через методы API 2. Успешно выполнил задание, созданное заказчиком. 3. Зарегистрировался в сервисе по реферальной ссылке заказчика.
• Выплаты — транзакции за выполненные задания.
• Баланс — номинальный счет заказчика, используемый совершения выплат.
• Документы — документация, необходимая для отчетности и организации процесса выплат.

Возможности API

• Приглашать исполнителей и запрашивать информацию о зарегистрированных исполнителях
• Запрашивать информацию о договорах, персональных документах исполнителей
• Создавать задания для исполнителей
• Формировать реестры на выплаты, оплачивать выполненные задания
• Создавать акты и запрашивать информацию о созданных на платформе актах
• Работать со номинальным счетом на платформе: запрашивать выписки, историю пополнений счета

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

• 1000 запросов в секунду

Данные и методы:

• API поддерживает методы GET и POST. Все запросы и ответы передаются в формате JSON, что обеспечивает совместимость с большинством языков программирования.

Структура ошибок:

• API возвращает стандартные коды ошибок HTTP: 4xx для клиентских ошибок, 5xx для серверных