sdelano.me Public API — руководство по интеграции
Версия API: 1.0.0. Дата обновления документации: 18 ноября 2026 года.
Источники: Swagger UI и OpenAPI JSON.
Содержание
- Назначение и основные сущности
- Подключение
- Сценарий интеграции
- Общие правила
- Rate limit
- Справочник методов
- Схемы данных и перечисления
Назначение и основные сущности
API позволяет получать сведения об организации, приглашать исполнителей, работать с участниками и их профилями, создавать реестры и задания, загружать файлы результата и оплачивать неоплаченные задания реестра.
| Сущность | Идентификатор | Значение |
|---|---|---|
| Организация | organisationId |
Организация владельца API-ключа |
| Приглашение | organisationInviteId |
Персональное приглашение по email |
| Участник организации | organisationMemberId |
Участие пользователя в организации |
| Профиль исполнителя | executorId |
Профиль с налоговыми и идентификационными данными |
| Реестр | registryId |
Объединяет участников и задания |
| Задание реестра | registryApplicationId |
Описание работы, категория, цена и источник результатов |
| Заказ | orderId |
Оплаченный заказ, связанный с заданием |
| Счёт плательщика | id в /payers/list, corporateId в запросе оплаты |
Доступный источник оплаты; особенности баланса sdelano.me требуют уточнения |
| Временный файл | id типа string |
Файл перед прикреплением к заданию; в запросе передаётся через temporaryFileIds |
Идентификаторы участника, профиля исполнителя, задания и заказа обозначают разные сущности и не взаимозаменяемы.
У одного пользователя может быть несколько профилей исполнителя с разным налоговым статусом: физическое лицо, самозанятый и ИП. В организацию добавляются выбранные профили исполнителя; после добавления они становятся активными. Пользователь и профиль исполнителя — разные сущности: принятие приглашения пользователем предшествует добавлению его выбранных профилей в организацию.
В реестре может быть один или несколько активных исполнителей, у каждого — одно или несколько заданий. У каждого добавленного исполнителя свой organisationMemberId, в том числе если несколько исполнителей принадлежат одному пользователю. Для добавления в реестр и создания задания передавайте organisationMemberId именно нужного исполнителя. В ответе участника его профиль представлен полем executor, которое содержит executorId и taxStatus.
Подключение
Окружение и авторизация
Базовый адрес API:
https://api.sdelano.me
API-токен (API-ключ) создаётся в личном кабинете: Настройки → API. При создании задаются срок действия и права доступа.
Доступные сроки действия: 30, 90, 180, 365 дней или бессрочно. Созданный токен можно отозвать.
| Право | Назначение |
|---|---|
| Чтение | Получение данных через API |
| Чтение и запись | Получение и изменение данных через API |
| Оплата | Оплата реестров через API |
Если интеграция должна оплачивать реестры, задайте право «Оплата» при создании токена. Точная схема сочетания прав и матрица доступа к отдельным методам в текущем OpenAPI не описаны.
Истёкший или отозванный токен не подходит для дальнейшей авторизации: для продолжения работы интеграции создайте новый токен и обновите значение X-Api-Key. Бессрочный токен также можно отозвать.
Все 19 методов объявляют авторизацию заголовком X-Api-Key. Для оплаты через Public API 2FA не требуется: возможность оплаты определяется правом токена. Пути методов имеют префикс /public/. Swagger доступен по адресу https://api.sdelano.me/docs; /docs не входит в базовый адрес API. В OpenAPI список servers пуст.
export SDELANO_BASE_URL='https://api.sdelano.me'
export SDELANO_API_KEY='<API_KEY>'
curl --request GET \
--url "${SDELANO_BASE_URL}/public/organisation/info" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
Замените <API_KEY> своим токеном.
Как читать примеры
Все числовые ID и UUID в примерах условные. Подставляйте значения, полученные от API. JSON-примеры запросов соответствуют объявленным типам и ограничениям длины, но это не подтверждает бизнес-валидность выбранного состояния, категории или режима результатов.
Сценарий интеграции
- Создать API-токен в личном кабинете, в разделе Настройки → API, выбрав срок действия (30, 90, 180, 365 дней или бессрочно) и необходимые права. Если планируется оплата реестров, задать право оплаты. Проверить организацию через
GET /public/organisation/info. - Пригласить пользователя одним из двух способов: передать универсальную ссылку
inviteLinkиз/organisation/infoлибо создать персональное приглашение черезPUT /public/organisation/invites/create. Персональное приглашение отправляется на указанный email. - Дождаться, пока пользователь примет приглашение и зарегистрируется по ссылке. Проверять персональные приглашения через
/organisation/invites/search, а участников — через/organisation/members/search. Дополнительные действия для уже зарегистрированного пользователя ещё уточняются. - Получить профили пользователя через
/organisation/members/executorsи добавить выбранные профили в организацию через/organisation/members/append_executors. Можно добавить отдельные профили: физлицо, самозанятого или ИП. Добавленные исполнители становятся активными, у каждого свойorganisationMemberId. После добавления перечитать/organisation/members/searchи сопоставить записи поexecutor.executorIdиexecutor.taxStatus. - Создать реестр через
/registries/create; новый реестр имеет статусdraft. СохранитьregistryId. - Добавить одного или нескольких активных исполнителей в реестр через
/registries/add_member. Метод принимаетorganisationMemberId; при нескольких исполнителях выполнить отдельный запрос для каждого соответствующего участника. - Получить подходящие категории через
/registries/categories, передавorganisationMemberId. Для задания выбирать категорию сselectable: true; описание метода разрешает выбор только уровня 2. - Если результат предоставляет заказчик, загрузить файлы через
/registries/upload_temporary_file, сохранить ихidи передать черезtemporaryFileIds. Проверка файлов асинхронная; порядок ожидания проверки требует уточнения. - Создать одно или несколько заданий для каждого добавленного исполнителя через
/registries/create_application. Сохранить каждыйregistryApplicationId. Описание задания должно содержать от 500 до 100000 символов; цена передаётся в копейках. - После добавления всех необходимых исполнителей и создания заданий активировать реестр через
/registries/activate: переходdraft→created. - Получить плательщиков через
GET /public/payers/listи выбрать источник оплаты. Проверить реестр через/registries/info: в нём возвращаются расчёт стоимости и ошибки заданий. - Запустить оплату реестра через
/registries/pay_registry, передавregistryIdиcorporateId. Сейчас выбор отдельных заданий для оплаты недоступен; такая возможность планируется позднее. 2FA не требуется, но у ключа должно быть право оплаты. Задание, не прошедшее проверку, не оплачивается. Поведение остальных заданий и общий ответ при такой ошибке ещё уточняются. Повторный вызов для уже оплаченного реестра возвращает406 Not Acceptable. - Отслеживать связанные заказы через
/registries/info: доступныstatus,resultsVerification, суммы, а у задания —actSignedи необязательныйorderId. - Оплаченный реестр можно закрыть через
/registries/close. По описанию метода закрытие удаляет неоплаченные задания, если они присутствуют. Точный итоговый статус закрытого реестра ещё уточняется.
Аннулирование приглашения
Персональное приглашение можно аннулировать через POST /public/organisation/invites/annulate, передав organisationInviteId. После аннулирования зарегистрироваться по ссылке этого приглашения не получится. Универсальная ссылка организации — отдельный способ приглашения; метод аннулирования адресуется конкретному персональному приглашению по его ID.
Архивация и редактирование реестра
Созданный реестр можно отправить в архив, а затем при необходимости активировать. Архивация и последующая активация позволяют вернуться к работе с реестром.
В активный реестр можно добавлять новых исполнителей и создавать новые задания. Для этого используются те же методы /registries/add_member и /registries/create_application, что и при первоначальном наполнении. Первоначальное создание всех заданий до активации — основной сценарий, но активация не запрещает последующее добавление исполнителей и заданий.
В использованной версии OpenAPI отдельный метод архивации, статус архивного реестра и контракт повторной активации не описаны. Возможность подтверждена владельцем API; конкретные вызовы архивации и восстановления будут добавлены после уточнения контракта. Метод /registries/close описывает закрытие с удалением неоплаченных заданий, поэтому использовать его как метод архивации без подтверждения не следует. Текущий контракт /registries/activate описывает только переход draft → created.
Способ получения результата задания
Поле resultsMode задаёт способ получения результата выполнения задания.
| Значение | Кто предоставляет результат | Как используется |
|---|---|---|
none |
Результат не требуется | Не нужно предоставлять результат выполнения задания |
generate |
Сервис с помощью AI | Результат генерируется автоматически с помощью AI; точный момент запуска генерации ещё уточняется |
customer |
Заказчик | Заказчик прикладывает результат при создании задания; для предварительно загруженных файлов используется temporaryFileIds |
executor |
Исполнитель | Исполнитель добавляет результат в своём личном кабинете |
Для режима customer необходимость хотя бы одного файла и возможность результата другого вида ещё уточняются. Для generate и executor не следует требовать от заказчика предварительно загружать файл только на основании наличия temporaryFileIds в общей схеме запроса.
Оплата: текущие возможности
| Правило | Поведение |
|---|---|
| Право оплаты | Задаётся при создании ключа в личном кабинете |
| Подтверждение 2FA | Не требуется для Public API |
| Объём запроса оплаты | Реестр; выбрать отдельные задания сейчас нельзя |
| Выбор части заданий | Планируется позднее |
| Выбор плательщика | Получить список через /payers/list, затем передать corporateId |
| Задание не прошло проверку | Это задание не оплачивается; судьба остальных заданий и общий ответ операции ещё уточняются |
| Повторная оплата уже оплаченного реестра | 406 Not Acceptable; конкретный код в JSON-теле пока не подтверждён |
| Повтор после таймаута или технического сбоя | Правила повторов и идемпотентность требуют уточнения |
Недоступность выбора части заданий не означает, что все задания гарантированно будут оплачены: задание с ошибкой проверки не оплачивается. Нельзя считать операцию атомарной без отдельного подтверждения поведения остальных заданий и технических сбоев.
Контроль после оплаты
Сохраняйте идентификаторы реестра и заданий и сопоставляйте их с orders из /registries/info. Поля registryApplicationId и executorId в заказе объявлены необязательными — обработчик должен учитывать их отсутствие.
Если запрос оплаты завершился сетевым таймаутом, результат операции неизвестен. До согласования идемпотентности рекомендуется перечитать реестр и сверить связанные заказы перед повторным вызовом. Универсального идентификатора платёжной операции публичный ответ не содержит.
406 Not Acceptable при повторной оплате уже оплаченного реестра — подтверждённый сценарий. Однако этот HTTP-код используется и для других ошибок: одного статуса 406 недостаточно, чтобы заключить, что реестр уже оплачен. Анализируйте тело ответа и текущее состояние реестра; точный доменный код для этого случая ещё уточняется.
Общие правила
Форматы данных
- JSON используется для обычных тел запросов и ответов; файлы загружаются через
multipart/form-data. - Денежные суммы, для которых это явно указано, передаются в копейках:
100000= 1000 рублей. Единицы неописанных полей следует подтвердить отдельно. - Большинство полей времени описаны как Unix timestamp в миллисекундах. У
deadlineединица явно не указана;birthdayимеет форматdd.MM.yyyy. - Обязательность в таблицах отражает только
requiredиз OpenAPI. Отсутствие поля вrequiredне означает автоматически допустимостьnull. - Для ответа
204тело не описано: не вызывайте безусловный JSON-парсинг.
Пагинация
| Метод | Порядок | Значение startAfter |
|---|---|---|
/registries/list |
ID по убыванию | Вернуть ID меньше курсора |
/organisation/invites/search |
ID по возрастанию | Вернуть ID больше курсора |
/organisation/members/search |
ID по возрастанию | Вернуть ID больше курсора |
/organisation/members/executors |
Условие курсора задаёт движение к большим ID | Вернуть ID больше курсора |
Для этих методов limit по умолчанию равен 50, допустимые значения — 1–100. Передавайте nextStartAfter ответа в startAfter следующего запроса. Необязательный курсор может отсутствовать; для участников явно описано, что он возвращается только при наличии следующей страницы.
В поиске приглашений и участников status — массив. По правилам OpenAPI query-массив без переопределения style/explode передаётся повторением параметра: ?status=pending&status=active. Поддержку этой сериализации сервером нужно проверить при интеграционном тестировании. У реестров status — одиночное значение.
Ошибки
ApiError содержит code и message. ValidationError содержит code и массив строк errors. Доменная ошибка может быть представлена строковым кодом; структура связи ошибки с конкретным полем не описана.
Иллюстрация формы ошибки валидации; точный набор строк зависит от метода:
{
"code": "INVALID_INPUT_PARAMS",
"errors": ["registryNotFound"]
}
| HTTP-код | Описание по контракту |
|---|---|
401 |
Нет API-ключа либо ключ некорректен |
404 |
Реестр не найден; для списка плательщиков — нет привязки к click.ru |
406 |
Ошибки валидации или доменные ошибки, перечисленные для метода |
429 |
Превышен лимит Public API: 180 запросов за 1 минуту или 360 запросов за 5 минут. Подробнее — в разделе Rate limit |
502 |
Для списка плательщиков: Click.ru недоступен и оплата через sdelano.me отключена |
Полный набор документированных ответов приведён у каждого метода. Таблица выше не означает, что каждый код объявлен у всех методов. Для /payers/list тела ошибок не описаны.
Rate limit
Для Public API действуют два ограничения частоты запросов одновременно:
| Интервал | Максимальное количество запросов |
|---|---|
| 1 минута | 180 |
| 5 минут | 360 |
Соблюдение минутного лимита не отменяет ограничение за 5 минут. Например, отправка 180 запросов каждую минуту не соответствует пятиминутному лимиту.
При превышении лимита API возвращает HTTP 429 Too Many Requests. Приостановите отправку запросов и повторите их после освобождения лимита. В интеграции рекомендуется использовать очередь запросов и ограничивать частоту опроса статусов.
Справочник методов
| Метод | Путь | Назначение |
|---|---|---|
GET |
/public/registries/list |
Получить список реестров |
GET |
/public/registries/info |
Получить полную информацию о реестре |
POST |
/public/registries/upload_temporary_file |
Загрузить временный файл для задания реестра |
POST |
/public/registries/create |
Создать реестр |
POST |
/public/registries/activate |
Активировать реестр |
POST |
/public/registries/close |
Закрыть реестр и удалить неоплаченные задания |
POST |
/public/registries/add_member |
Добавить участника в реестр |
POST |
/public/registries/remove_member |
Удалить участника из реестра |
GET |
/public/registries/categories |
Получить подходящие категории реестровых заданий |
POST |
/public/registries/create_application |
Создать задание для участника реестра |
POST |
/public/registries/pay_registry |
Оплатить все неоплаченные задания реестра |
GET |
/public/organisation/info |
Получить информацию об организации |
GET |
/public/organisation/invites/search |
Найти приглашения организации |
PUT |
/public/organisation/invites/create |
Создать приглашение исполнителю |
POST |
/public/organisation/invites/annulate |
Аннулировать приглашение |
GET |
/public/organisation/members/search |
Найти участников организации |
GET |
/public/organisation/members/executors |
Получить профили исполнителей участника |
POST |
/public/organisation/members/append_executors |
Добавить профили исполнителей участнику |
GET |
/public/payers/list |
Список плательщиков для реестров |
1. Получить список реестров
GET /public/registries/list
Возвращает реестры организации владельца API-ключа в порядке убывания ID с фильтром по статусу и курсорной пагинацией.
| Параметр query | Тип | Обязателен | Описание и ограничения |
|---|---|---|---|
status |
RegistryStatus | Нет | Статус реестров |
startAfter |
integer |
Нет | Вернуть реестры с ID меньше курсора; мин.: 1; макс.: 2147483647 |
limit |
integer |
Нет | мин.: 1; макс.: 100; по умолчанию: 50 |
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | RegistryPublicListView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибка валидации запроса. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/registries/list" \
--get \
--data-urlencode 'limit=50' \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
2. Получить полную информацию о реестре
GET /public/registries/info
Возвращает сведения о реестре, сотрудниках, исполнителях, заявках, заказах и расчёте цены.
| Параметр query | Тип | Обязателен | Описание и ограничения |
|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра |
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | RegistryPublicInfoView |
401 |
Отсутствует или некорректен API-ключ | ApiError |
404 |
Реестр не найден | ApiError |
429 |
Превышен общий лимит публичного API | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/registries/info" \
--get \
--data-urlencode 'registryId=1001' \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
3. Загрузить временный файл для задания реестра
POST /public/registries/upload_temporary_file
Принимает файл через multipart/form-data, сохраняет его для текущего владельца API-ключа и запускает асинхронную антивирусную проверку. Возвращенный id можно передать в temporaryFileIds при создании задания с результатами от заказчика.
Тело: multipart/form-data, обязательно. Схема: TemporaryUploadedFileUploadRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | TemporaryUploadedFileView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Файл обязателен; имя должно содержать не более 255 символов. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/upload_temporary_file" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--form 'file=@./result.txt' \
--form 'name=result.txt'
4. Создать реестр
POST /public/registries/create
Создает реестр в статусе draft для организации владельца API-ключа.
Тело: application/json, обязательно. Схема: RegistryPublicCreateRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | RegistryPublicView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/create" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Контент за ноябрь 2026"
}'
5. Активировать реестр
POST /public/registries/activate
Переводит реестр организации владельца API-ключа из статуса draft в created.
Уточнение сценария от владельца API: В основном сценарии активируйте реестр после добавления исполнителей и создания заданий, перед оплатой. Активный реестр можно дополнять новыми исполнителями и заданиями. Созданный реестр также можно архивировать и затем активировать, однако контракт API для архивации и повторной активации пока требует уточнения; текущая спецификация этого метода описывает только переход draft → created.
Тело: application/json, обязательно. Схема: RegistryPublicActivateRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
204 |
Реестр активирован. | Тело не описано |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/activate" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"registryId": 1001
}'
6. Закрыть реестр и удалить неоплаченные задания
POST /public/registries/close
Закрывает активный реестр организации владельца API-ключа и удаляет его неоплаченные задания.
Уточнение сценария от владельца API: В подтверждённом основном сценарии оплаченный реестр можно закрыть. Удаление неоплаченных заданий указано в описании метода; итоговый статус после закрытия ещё уточняется.
Тело: application/json, обязательно. Схема: RegistryPublicCloseRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
204 |
Реестр закрыт. | Тело не описано |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/close" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"registryId": 1001
}'
7. Добавить участника в реестр
POST /public/registries/add_member
Добавляет активного участника организации, у которого назначен профиль исполнителя.
Уточнение сценария от владельца API: В реестр можно добавить одного или нескольких активных исполнителей. Для каждого соответствующего участника используется отдельный запрос. Добавлять новых исполнителей можно и в активный реестр. У каждого исполнителя может быть несколько заданий.
Тело: application/json, обязательно. Схема: RegistryPublicMemberRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
201 |
Участник добавлен в реестр. | Тело не описано |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/add_member" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"registryId": 1001,
"organisationMemberId": 2001
}'
8. Удалить участника из реестра
POST /public/registries/remove_member
Удаляет связь участника организации с реестром в статусе draft или created.
Тело: application/json, обязательно. Схема: RegistryPublicMemberRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
204 |
Участник удалён из реестра. | Тело не описано |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/remove_member" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"registryId": 1001,
"organisationMemberId": 2001
}'
9. Получить подходящие категории реестровых заданий
GET /public/registries/categories
Возвращает плоский список подходящих категорий уровней 0–2 для участника; связи с родителями передаются через parentId (0 для корневых категорий). Узлы группировки включаются только при наличии подходящих потомков. Выбирать можно только категории уровня 2.
| Параметр query | Тип | Обязателен | Описание и ограничения |
|---|---|---|---|
organisationMemberId |
integer |
Да | Идентификатор участника организации; мин.: 1; макс.: 2147483647 |
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | RegistryPublicCategoriesView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/registries/categories" \
--get \
--data-urlencode 'organisationMemberId=2001' \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
10. Создать задание для участника реестра
POST /public/registries/create_application
Создает задание для уже добавленного участника и возвращает идентификатор созданного задания.
Уточнение сценария от владельца API: Метод можно вызвать несколько раз для одного исполнителя, чтобы создать несколько заданий. Передавайте его собственный organisationMemberId. В основном сценарии задания создаются до активации реестра; создавать новые задания можно также в активном реестре. resultsMode: none — результат не требуется; generate — генерация с помощью AI; customer — результат прикладывает заказчик при создании задания; executor — результат добавляет исполнитель в своём личном кабинете.
Тело: application/json, обязательно. Схема: RegistryPublicCreateApplicationRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | RegistryPublicApplicationView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/create_application" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"registryId": 1001,
"organisationMemberId": 2001,
"title": "Подготовка текста для страницы услуги",
"description": "Подготовить комплект текстовых материалов для страницы услуги. Изучить предоставленное описание продукта, определить целевую аудиторию и сформулировать основные преимущества. Составить заголовок, вводный абзац, описание характеристик, блок с ответами на частые вопросы и призыв к действию. Проверить орфографию, пунктуацию, достоверность утверждений и единообразие терминологии. Передать готовый результат в текстовом файле с понятной структурой разделов. Не использовать неподтвержденные обещания, чужие тексты и сведения, отсутствующие в исходных материалах. Все спорные формулировки согласовать с заказчиком до завершения работы.",
"categoryId": 3001,
"price": 100000,
"resultsMode": "customer",
"temporaryFileIds": [
"00000000-0000-4000-8000-000000000001"
]
}'
В этом примере выбран customer: заказчик прикладывает результат при создании задания. Замените условный UUID на ID загруженного файла с результатом. Категория должна быть доступна выбранному исполнителю. Точный порядок ожидания проверки файлов требует согласования.
11. Оплатить все неоплаченные задания реестра
POST /public/registries/pay_registry
Оплачивает неоплаченные задания реестра со счёта указанного плательщика. Реестр должен принадлежать владельцу API-ключа.
Уточнение сценария от владельца API: Для вызова у API-ключа должно быть право оплаты, заданное при его создании в разделе «Настройки → API». 2FA не требуется. Выбор отдельных заданий для оплаты сейчас недоступен и планируется позднее. Задание, не прошедшее проверку, не оплачивается; поведение остальных заданий и общий ответ операции ещё уточняются. Повторный запрос для уже оплаченного реестра возвращает 406 Not Acceptable; конкретный код ошибки в теле ответа пока не подтверждён.
Тело: application/json, обязательно. Схема: RegistryPublicPayRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | RegistryPublicPaymentDetailsView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки оплаты перечислены в RegistryError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/registries/pay_registry" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"registryId": 1001,
"corporateId": 4001
}'
12. Получить информацию об организации
GET /public/organisation/info
Возвращает идентификатор, название и статус организации, а также универсальную ссылку приглашения.
Уточнение сценария от владельца API: Универсальная ссылка inviteLink используется для приглашения пользователей без создания персонального приглашения.
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | OrganisationPublicInfoView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибка валидации запроса. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/organisation/info" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
13. Найти приглашения организации
GET /public/organisation/invites/search
Возвращает персональные приглашения в порядке возрастания ID с фильтром по статусам.
| Параметр query | Тип | Обязателен | Описание и ограничения |
|---|---|---|---|
status |
массив: OrganisationInviteStatus | Нет | — |
startAfter |
integer |
Нет | Вернуть элементы с идентификатором больше курсора; мин.: 1; макс.: 2147483647 |
limit |
integer |
Нет | мин.: 1; макс.: 100; по умолчанию: 50 |
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | OrganisationPublicInvitePageView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибка валидации запроса. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/organisation/invites/search" \
--get \
--data-urlencode 'limit=50' \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
14. Создать приглашение исполнителю
PUT /public/organisation/invites/create
Создает персональное приглашение
Уточнение сценария от владельца API: Персональное приглашение отправляется на email из запроса. Пользователь принимает приглашение и регистрируется по ссылке; затем выбранные профили исполнителя можно добавить в организацию.
Тело: application/json, обязательно. Схема: OrganisationPublicCreateInviteRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | OrganisationPublicInviteView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в InviteFreelancerError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request PUT \
--url "${SDELANO_BASE_URL}/public/organisation/invites/create" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"email": "executor@example.com"
}'
15. Аннулировать приглашение
POST /public/organisation/invites/annulate
Аннулирует приглашение организации с указанным organisationInviteId из ответа. Ошибки доменной проверки возвращаются кодами InviteFreelancerError.
Уточнение сценария от владельца API: После аннулирования приглашения зарегистрироваться по его ссылке не получится. Передайте ID конкретного персонального приглашения в organisationInviteId.
Тело: application/json, обязательно. Схема: OrganisationPublicAnnulateInviteRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
204 |
Приглашение аннулировано. | Тело не описано |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в InviteFreelancerError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/organisation/invites/annulate" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"organisationInviteId": 5001
}'
16. Найти участников организации
GET /public/organisation/members/search
Возвращает компактные сведения об участниках в порядке возрастания ID с фильтром по статусам. limit по умолчанию равен 50 и не может превышать 100. startAfter задает последний уже полученный ID; nextStartAfter возвращается только если доступна следующая страница.
| Параметр query | Тип | Обязателен | Описание и ограничения |
|---|---|---|---|
status |
массив: OrganisationMemberStatus | Нет | — |
startAfter |
integer |
Нет | Вернуть элементы с идентификатором больше курсора; мин.: 1; макс.: 2147483647 |
limit |
integer |
Нет | мин.: 1; макс.: 100; по умолчанию: 50 |
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | OrganisationPublicMemberPageView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в OrganisationMemberError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/organisation/members/search" \
--get \
--data-urlencode 'limit=50' \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
17. Получить профили исполнителей участника
GET /public/organisation/members/executors
Возвращает активные профили исполнителей сотрудника.
| Параметр query | Тип | Обязателен | Описание и ограничения |
|---|---|---|---|
organisationMemberId |
integer |
Да | Идентификатор участника организации; соответствует полю organisationMemberId в ответе; мин.: 1; макс.: 2147483647 |
startAfter |
integer |
Нет | Вернуть элементы с идентификатором больше курсора; мин.: 1; макс.: 2147483647 |
limit |
integer |
Нет | мин.: 1; макс.: 100; по умолчанию: 50 |
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | OrganisationPublicExecutorPageView |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в OrganisationMemberError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/organisation/members/executors" \
--get \
--data-urlencode 'organisationMemberId=2001' \
--data-urlencode 'limit=50' \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
18. Добавить профили исполнителей участнику
POST /public/organisation/members/append_executors
Добавляет выбранные профили исполнителей в организацию для указанного участника. Передайте непустой список положительных executorIds. Ошибки доменной проверки возвращаются кодами OrganisationMemberError.
Уточнение сценария от владельца API: В организацию можно добавить несколько выбранных профилей одного пользователя с разным налоговым статусом. Добавленные исполнители становятся активными; у каждого добавленного исполнителя свой organisationMemberId. После вызова перечитайте список участников для получения соответствующих ID.
Тело: application/json, обязательно. Схема: OrganisationPublicAppendExecutorsRequest.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
201 |
Профили исполнителей добавлены участнику организации. | Тело не описано |
401 |
Отсутствует или некорректен API-ключ. | ApiError |
406 |
Ошибки валидации перечислены в OrganisationMemberError. | ValidationError |
429 |
Превышен общий лимит публичного API. | ApiError |
Пример запроса:
curl --request POST \
--url "${SDELANO_BASE_URL}/public/organisation/members/append_executors" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"organisationMemberId": 2001,
"executorIds": [
6001
]
}'
19. Список плательщиков для реестров
GET /public/payers/list
Возвращает плательщиков Click.ru, доступных для оплаты реестров, и баланс sdelano.me, если эта оплата включена.
Тело запроса не описано.
| HTTP | Описание | Схема тела ответа |
|---|---|---|
200 |
Описание не задано | ExternalAccounts |
401 |
Отсутствует или некорректен API-ключ | Тело не описано |
404 |
Пользователь не имеет привязки к click.ru | Тело не описано |
429 |
Превышен общий лимит публичного API | Тело не описано |
502 |
Click.ru недоступен и оплата через sdelano.me отключена | Тело не описано |
Пример запроса:
curl --request GET \
--url "${SDELANO_BASE_URL}/public/payers/list" \
--header "X-Api-Key: ${SDELANO_API_KEY}" \
--header 'Accept: application/json'
Схемы данных и перечисления
Названия сохранены из OpenAPI для сопоставления с генерируемыми клиентами. Поля, описания, ограничения и обязательность воспроизведены из контракта; отсутствующие сведения не дополнены предположениями.
RegistryError
Набор ошибок данного задания, не позволяющий его оплатить
Тип: string. Допустимые значения:
registryNotFoundregistryNotActiveorganisationNotFoundleaderNotFoundleaderBalancesNotFoundworkerNotFoundnameEmptynameLongincludeNdflTaxWrongapplicationTitleShortapplicationTitleLongapplicationTitleWrongapplicationDescriptionShortapplicationDescriptionLongapplicationDescriptionWrongapplicationPriceWrongapplicationResultModeWrongapplicationResultsMissingapplicationResultsPendingapplicationResultsFailedapplicationTemporaryFilesNotFoundapplicationAttachmentNotFoundapplicationDurationWrongapplicationCategoryNotMatchesOkvedapplicationCategoryNotAllowedcategoryNotFoundmemberNotFoundleaderBalanceNotEnoughmemberAlreadyAddedapplicationNotFoundapplicationsFromDifferentRegistriesregistryInvalidStatusregistryHasPaidOrdersapplicationIsAssignedexecutorNotFoundexecutorBalanceNotFoundexecutorNotActiveinvalidCorporateIdremoteHoldFailedregistry2faRequiredregistry2faInvalidCoderegistry2faMethodNotAllowedregistry2faChallengeNotFoundregistry2faChallengeExpiredregistry2faChallengeMismatchregistry2faNotConfigured
RegistryPublicErrorEnums
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryError |
RegistryError | Да | Не задано | — |
RegistryStatus
Статус реестра
Тип: string. Допустимые значения:
draftcreatedcompleteddeleted
RegistryPublicView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра | — |
name |
string |
Да | Название реестра | — |
status |
RegistryStatus | Да | Не задано | — |
created |
integer |
Да | Дата создания в миллисекундах Unix | — |
updated |
integer |
Да | Дата последнего обновления в миллисекундах Unix | — |
RegistryPublicListView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
items |
массив: RegistryPublicView | Да | Реестры в порядке убывания ID | — |
nextStartAfter |
integer |
Нет | Передайте это значение в startAfter для получения следующей страницы | — |
ApiErrorCode
Error code
Тип: string. Допустимые значения:
UNKNOWN_ERRORINVALID_INPUT_PARAMSFILE_LARGERATE_LIMIT_EXCEEDED
ApiError
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
code |
ApiErrorCode | Да | Не задано | — |
message |
string |
Да | Error description | — |
ValidationError
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
code |
ApiErrorCode | Да | Не задано | — |
errors |
массив: string |
Да | failed fields | — |
OrganisationMemberStatus
Тип: string. Допустимые значения:
pendingactivearchived
TaxStatus
Налоговый статус плательщика, влияет на налоги и список способов выплаты
Тип: string. Допустимые значения:
individualRuindividualOtherselfEmployedentrepreneurlegalEntity
IdentificationDocumentType
Тип документа, удостоверяющего личность
Тип: string. Допустимые значения:
localPassportRuforeignPassportRupassportOther
IndividualDetailsView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
firstName |
string |
Да | Имя | — |
lastName |
string |
Да | Фамилия | — |
middleName |
string |
Нет | Отчество | — |
birthday |
string |
Да | Дата рождения, формат: dd.MM.yyyy | — |
identificationDocumentType |
IdentificationDocumentType | Да | Не задано | — |
documentNumber |
string |
Да | Серия и номер документа, удостоверяющего личность | — |
ruTaxResident |
boolean |
Да | Налоговый статус: является ли резидентом РФ | — |
orgName |
string |
Нет | Название организации для ИП | — |
VatMode
Режим НДС для ИП
Тип: string. Допустимые значения:
exemptusn5usn7general
ExecutorPublicView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
executorId |
integer |
Да | Идентификатор профиля исполнителя | — |
taxStatus |
TaxStatus | Да | Не задано | — |
inn |
string |
Да | ИНН | — |
ogrn |
string |
Нет | ОГРН/ОГРНИП | — |
individualDetails |
IndividualDetailsView | Да | Не задано | — |
vatMode |
VatMode | Да | Не задано | — |
okveds |
массив: string |
Нет | Список ОКВЭД для ИП | — |
OrganisationPublicMemberView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
organisationMemberId |
integer |
Да | Идентификатор участника организации | мин.: 1; макс.: 2147483647 |
status |
OrganisationMemberStatus | Да | Не задано | — |
created |
integer |
Да | Время добавления, Unix timestamp в миллисекундах | — |
email |
string |
Нет | Email пользователя | — |
avatar |
string |
Нет | Аватар пользователя | — |
login |
string |
Нет | Логин пользователя | — |
phone |
string |
Нет | Телефон пользователя | — |
executor |
ExecutorPublicView | Нет | Профиль исполнителя участника | — |
RegistryApplicationAttachmentType
Тип вложения: файл или ссылка
Тип: string. Допустимые значения:
filelink
OrderFileStatus
Тип: string. Допустимые значения:
pendingcheckedvirusfailed
RegistryPublicInfoAttachmentView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
id |
string |
Да | Идентификатор вложения заявки реестра | — |
type |
RegistryApplicationAttachmentType | Да | Не задано | — |
name |
string |
Нет | Отображаемое имя файла или подпись ссылки | — |
value |
string |
Нет | Значение вложения. Для типа link здесь хранится URL, для file поле не заполняется. | — |
size |
integer |
Да | Размер файла в байтах. Для ссылок равен 0. | — |
created |
integer |
Да | Время добавления вложения в unix timestamp ms | — |
status |
OrderFileStatus | Да | Не задано | — |
RegistryPublicInfoApplicationView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryApplicationId |
number |
Да | Не задано | — |
title |
string |
Да | Не задано | — |
description |
string |
Да | Не задано | — |
categoryId |
number |
Да | Не задано | — |
price |
number |
Да | Не задано | — |
ndfl |
number |
Да | Не задано | — |
orderId |
number |
Нет | Не задано | — |
actSigned |
boolean |
Да | Флаг финального подписания акта по созданному заказу | — |
organisationMemberId |
number |
Да | Идентификатор участника организации | — |
created |
number |
Да | Не задано | — |
resultsMode |
string |
Да | Источник результатов выполнения задания | — |
attachments |
массив: RegistryPublicInfoAttachmentView | Нет | Вложения, приложенные к заявке реестра до оплаты | — |
errors |
массив: RegistryError | Нет | Не задано | — |
OrderResultsVerificationStatus
Тип: string. Допустимые значения:
nonewaitingpendingprocessingokfailedrejected
RegistryPublicInfoOrderResultsVerificationView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
status |
OrderResultsVerificationStatus | Да | Не задано | — |
error |
string |
Нет | Текст последней ошибки подготовки результатов заказа | — |
taskId |
integer |
Нет | Идентификатор задачи в tasks_queue, которая обрабатывает результаты заказа | — |
updated |
integer |
Да | Дата последнего обновления статуса подготовки результатов заказа в миллисекундах | — |
OrderStatus
Статус заказа
Тип: string. Допустимые значения:
createdpayedprovidedDatastartedfinishedresultModerationcompletedrejectedcancelledarbitragedeletedannulated
RegistryPublicInfoOrderView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
orderId |
integer |
Да | Идентификатор заказа | — |
created |
integer |
Да | Дата создания заказа в миллисекундах | — |
completionTitle |
string |
Нет | Название услуги, которое отображается в акте, УПД и чеке самозанятого | — |
executorId |
number |
Нет | Идентификатор исполнителя | — |
resultsVerification |
RegistryPublicInfoOrderResultsVerificationView | Да | Не задано | — |
status |
OrderStatus | Да | Не задано | — |
deadline |
integer |
Нет | Время истечения текущего статуса заказа | — |
registryApplicationId |
integer |
Нет | Не задано | — |
net |
integer |
Да | Цена заказа без налогов и комиссий в копейках | — |
fee |
integer |
Нет | Сумма комиссий для покупателя в копейках | — |
vat |
integer |
Нет | НДС для покупателя в копейках | — |
gross |
integer |
Да | Полная сумма заказа для покупателя в копейках | — |
RegistryPublicInfoPriceDetailsView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
net |
integer |
Да | Чистая сумма по заявкам реестра в копейках | — |
gross |
integer |
Да | Полная сумма по заявкам реестра в копейках | — |
fee |
integer |
Нет | Комиссия в копейках | — |
ndfl |
integer |
Нет | НДФЛ в копейках | — |
vat |
integer |
Нет | НДС в копейках | — |
RegistryPublicInfoView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registry |
RegistryPublicView | Да | Основная информация о реестре | — |
members |
массив: OrganisationPublicMemberView | Да | Справочник сотрудников и их исполнителей | — |
applications |
массив: RegistryPublicInfoApplicationView | Да | Заявки реестра | — |
orders |
массив: RegistryPublicInfoOrderView | Да | Оплаченные заказы, связанные с заявками | — |
priceDetails |
RegistryPublicInfoPriceDetailsView | Да | Расчёт цены реестра | — |
TemporaryUploadedFileUploadRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
name |
string |
Нет | Переопределенное отображаемое имя файла | — |
file |
file |
Да | Файл для предварительной загрузки | — |
TemporaryUploadedFileView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
id |
string |
Да | Идентификатор временного файла | — |
name |
string |
Да | Отображаемое имя файла | — |
size |
integer |
Да | Размер файла в байтах | — |
status |
OrderFileStatus | Да | Не задано | — |
expiresAt |
integer |
Да | Время истечения временного файла в unix timestamp ms | — |
RegistryPublicCreateRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
name |
string |
Да | Название реестра | мин. длина: 1; макс. длина: 50 |
RegistryPublicActivateRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра для активации | мин.: 1; макс.: 2147483647 |
RegistryPublicCloseRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра для закрытия | мин.: 1; макс.: 2147483647 |
RegistryPublicMemberRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра | мин.: 1; макс.: 2147483647 |
organisationMemberId |
integer |
Да | Идентификатор участника организации из публичного API организаций | мин.: 1; макс.: 2147483647 |
RegistryPublicCategoryView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
id |
integer |
Да | Идентификатор категории | — |
parentId |
integer |
Да | Идентификатор родительской категории; 0 для корневой категории | мин.: 0 |
name |
string |
Да | Название категории | — |
okveds |
массив: string |
Нет | ОКВЭДы категории | — |
selectable |
boolean |
Да | Можно ли выбрать категорию для задания | — |
RegistryPublicCategoriesView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
categories |
массив: RegistryPublicCategoryView | Да | Плоский список категорий уровней 0–2 | — |
RegistryApplicationResultsMode
Тип: string. Допустимые значения:
nonegeneratecustomerexecutor
Пояснения владельца API: none — результат не требуется; generate — результат генерируется с помощью AI; customer — результат прикладывает заказчик при создании задания; executor — результат добавляет исполнитель в личном кабинете.
RegistryPublicCreateApplicationRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра | мин.: 1; макс.: 2147483647 |
organisationMemberId |
integer |
Да | Идентификатор участника организации из публичного API организаций | мин.: 1; макс.: 2147483647 |
title |
string |
Да | Название задания | мин. длина: 5; макс. длина: 70 |
description |
string |
Да | Описание задания | мин. длина: 500; макс. длина: 100000 |
categoryId |
integer |
Да | Идентификатор категории задания | мин.: 1; макс.: 2147483647 |
price |
integer |
Да | Цена задания в копейках | мин.: 1; макс.: 1000000000 |
resultsMode |
RegistryApplicationResultsMode | Да | Не задано | — |
temporaryFileIds |
массив: string |
Нет | UUID временных файлов результата | — |
RegistryPublicApplicationView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryApplicationId |
integer |
Да | Идентификатор задания реестра | — |
registryId |
integer |
Да | Идентификатор реестра | — |
organisationMemberId |
integer |
Да | Идентификатор участника организации | — |
title |
string |
Да | Название задания | — |
description |
string |
Да | Описание задания | — |
categoryId |
integer |
Да | Идентификатор категории | — |
price |
integer |
Да | Цена задания | — |
resultsMode |
RegistryApplicationResultsMode | Да | Не задано | — |
created |
integer |
Да | Дата создания в миллисекундах Unix | — |
RegistryPublicPayRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
registryId |
integer |
Да | Идентификатор реестра | мин.: 1; макс.: 2147483647 |
corporateId |
integer |
Да | Идентификатор счёта плательщика в click.ru | — |
RegistryPublicPaymentDetailsView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
net |
integer |
Да | Чистая сумма оплаты в копейках | — |
gross |
integer |
Да | Полная сумма оплаты в копейках | — |
fee |
integer |
Нет | Комиссия в копейках | — |
ndfl |
integer |
Нет | НДФЛ в копейках | — |
vat |
integer |
Нет | НДС в копейках | — |
InviteFreelancerError
Тип: string. Допустимые значения:
organisationNotFoundorganisationNotActiveemailNotValidemailAlreadyRegisteredpasswordWronguserAgreementWrongpersonalDataWrongregistrationFaileduserNotFounduserNoLoginuserNoActiveExecutorsuserNotActiveuserNotWorkerinvitationAlreadySentinviteNotFoundfreelancerAlreadyInOrganisation
OrganisationMemberError
Тип: string. Допустимые значения:
organisationNotFoundorganisationNotActivememberNotFoundmemberNotPendingmemberNotActivememberNotArchivedexecutorNotFound
OrganisationPublicErrorEnums
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
inviteFreelancerError |
InviteFreelancerError | Да | Не задано | — |
organisationMemberError |
OrganisationMemberError | Да | Не задано | — |
OrganisationStatus
Статус организации
Тип: string. Допустимые значения:
activeinactive
OrganisationPublicInfoView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
organisationId |
integer |
Да | Идентификатор организации | — |
status |
OrganisationStatus | Да | Не задано | — |
inviteLink |
string |
Да | Универсальная ссылка для приглашения | — |
OrganisationInviteStatus
Тип: string. Допустимые значения:
pendingacceptedrejectedcanceledexpired
OrganisationPublicInviteView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
organisationInviteId |
integer |
Да | Идентификатор приглашения | мин.: 1; макс.: 2147483647 |
email |
string |
Да | Email приглашенного исполнителя | — |
status |
OrganisationInviteStatus | Да | Не задано | — |
inviteLink |
string |
Нет | Ссылка приглашения; отсутствует для устаревших ссылок | — |
created |
integer |
Да | Время создания, Unix timestamp в миллисекундах | — |
expiresAt |
integer |
Нет | Время истечения, Unix timestamp в миллисекундах | — |
acceptedAt |
integer |
Нет | Время принятия, Unix timestamp в миллисекундах | — |
rejectedAt |
integer |
Нет | Время отклонения, Unix timestamp в миллисекундах | — |
canceledAt |
integer |
Нет | Время отмены, Unix timestamp в миллисекундах | — |
OrganisationPublicInvitePageView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
items |
массив: OrganisationPublicInviteView | Да | Не задано | — |
nextStartAfter |
integer |
Нет | Курсор для следующей страницы | — |
OrganisationPublicCreateInviteRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
email |
string |
Да | Email для приглашения | — |
OrganisationPublicAnnulateInviteRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
organisationInviteId |
integer |
Да | Идентификатор приглашения; соответствует полю organisationInviteId в ответе | мин.: 1; макс.: 2147483647 |
OrganisationPublicMemberPageView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
items |
массив: OrganisationPublicMemberView | Да | Не задано | — |
nextStartAfter |
integer |
Нет | Курсор для следующей страницы | — |
OrganisationPublicExecutorView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
executorId |
integer |
Да | Идентификатор профиля исполнителя | — |
taxStatus |
TaxStatus | Да | Не задано | — |
inn |
string |
Да | ИНН | — |
ogrn |
string |
Нет | ОГРН/ОГРНИП | — |
individualDetails |
IndividualDetailsView | Да | Не задано | — |
vatMode |
VatMode | Да | Не задано | — |
okveds |
массив: string |
Нет | Список ОКВЭД для ИП | — |
existing |
boolean |
Да | Признак, что профиль уже добавлен в организацию | — |
OrganisationPublicExecutorPageView
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
items |
массив: OrganisationPublicExecutorView | Да | Не задано | — |
nextStartAfter |
integer |
Нет | Курсор для следующей страницы | — |
OrganisationPublicAppendExecutorsRequest
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
organisationMemberId |
integer |
Да | Идентификатор участника организации | мин.: 1; макс.: 2147483647 |
executorIds |
массив: integer |
Да | Идентификаторы профилей исполнителей | — |
ExternalAccount
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
id |
integer |
Да | Идентификатор счета во внешней системе | — |
name |
string |
Да | Название счета/плательщика во внешней системе | — |
balance |
number |
Да | Сумма средств на счете во внешней системе в копейках | — |
ExternalAccounts
| Поле | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
accounts |
массив: ExternalAccount | Да | Не задано | — |