Метод «СБИС.ПодготовитьДействие» подготавливает документ к переходу на следующий этап документооборота.
В формализованных документах метод:
- указывает идентификаторы участников документооборота;
- заполняет теги <Отправитель>, <Получатель>, <Подписант>;
- формирует имя файла по формату.
Также «СБИС.ПодготовитьДействие» формирует извещения о получении и ответные документы, если этого требует регламент документооборота.
Адрес запроса: https://online.sbis.ru/service/?srv=1
Параметры запроса
** — условно-обязательный параметр.
* — параметр для определения реквизитов при подписании, генерации и модификации документов.
- "Документ": объект:
- "Идентификатор"*:строка
- "Редакция": объект:
- "Идентификатор"*: строка
- "Этап"*: объект:
- "Название"**: строка, обязательна при обработке служебного этапа
- "Идентификатор"**: строка. Может быть пустой для действия «Отправить» этапа «Отправка» и «Утвердить» этапа «Утверждение»
- "Действие"*: объект:
- "Название"*: строка. Возможные значения
- "Комментарий"**: строка, комментарий к действию. Обязателен при аннулировании, отклонении документа и необходимости комментария
- "Сертификат"**: объект, сведения о сертификате. Параметр обязателен, если этап подразумевает подписание документа, изменение или генерацию файлов.
Если указаны «ФИО», «Должность», «ИНН» и «Отпечаток», сертификат определяется по параметру «Отпечаток». Если передать реквизиты недействительного сертификата, метод вернет ошибку- "Отпечаток"**: строка. Параметр обязателен, если не переданы «ФИО» + «Должность» + «ИНН»
- "ФИО"**: строка. Параметр обязателен, если не передан «Отпечаток»
- "Должность"**: строка. Параметр обязателен, если не передан «Отпечаток»
- "ИНН"**: строка. Параметр обязателен, если не передан «Отпечаток».
Для юридических лиц в РФ — 10 символов, для индивидуальных предпринимателей и физических лиц — 12. Для иностранных организаций номер определяет законодательство их стран - "ОГРНИП"*: строка
- "КодСтраны": строка, код страны в стандарте ISO 3166-1 alpha-2
- "Название": строка
- "Доверенность": массив объектов.
Если передаете информацию об электронной доверенности, укажите «ИдентификаторМЧД». Передаете информацию о бумажной доверенности — «ДействительнаС», «ВнутрНомер» и «ИННДоверителя»
- "ИдентификаторМЧД"**: строка, 36-разрядный GUID из имени файла
- "ВнутрНомер"**: строка, номер доверенности
- "ИННДоверителя"**: строка, ИНН доверителя. Для индивидуальных предпринимателей и физических лиц в РФ — 12 символов. Для иностранных лиц номер определяет законодательство их стран
- "ДействительнаС"**: строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время начала действия доверенности
- "ДействительнаПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время окончания действия доверенности
- "СистемаХраненияМЧД": строка. Адрес сайта, где зарегистрирована МЧД
- "Вложение": массив объектов (вложений документа для раздельной обработки):
- "Идентификатор": строка, идентификатор вложения
- "ДопПоля": строка, дополнительные параметры метода
Результат
Команда возвращает массив объектов со структурой:
- "Документ": объект:
- "Идентификатор": строка
- "Направление": строка
- "НашаОрганизация": объект:
- ...
- "Контрагент": объект:
- ...
- "Подразделение": объект:
- ...
- "Ответственный": объект:
- ...
- "Этап": массив объектов:
- "Название": строка
- "Идентификатор": строка
- "Служебный": строка «Да»/«Нет»
- "Действие": массив объектов:
- "Название": строка
- "ТребуетПодписания": строка «Да»/«Нет»
- "ТребуетКомментария": строка «Да»/«Нет»
- "Сертификат": массив объектов:
- "ФИО": строка
- "Должность": строка
- "ИНН": строка, ИНН. В Российской Федерации для юридических лиц номер состоит из 10 символов, для индивидуальных предпринимателей и физических лиц — из 12. Для иностранных организаций номер определяется требованиями законодательства их стран.
- "КодСтраны": строка, код страны в стандарте ISO 3166-1 alpha-2
- "ОГРНИП": строка
- "Название": строка
- "Отпечаток": строка
- "Квалифицированный": строка «Да»/«Нет»
- "ДействителенС": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время начала действия сертификата
- "ДействителенПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время окончания действия сертификата
- "Ключ": объект:
- "Активирован": строка «Да»/«Нет»
- "СпособАктивации": строка
- "Тип": строка
- "Вложение": массив объектов:
- "Название": строка
- "Идентификатор": строка
- "Модифицирован": строка
- "Файл": объект:
- "Имя": строка
- "Ссылка": строка
- "Хеш": строка в Base64. Представляет собой криптографический хеш загруженных бинарных данных.
Комментарий
Из поля «Отпечаток» объекта «Сертификат» извлекаются реквизиты данных, которые нужны для подготовки информации о подписанте в формализованных вложениях (ФИО, ИНН, название, должность, ОГРНИП и т. д.). Само значение отпечатка не сохраняется. Чтобы при закрытии этапа был использован нужный вам сертификат, обеспечьте его передачу в последующий вызов метода «СБИС.ВыполнитьДействие».
Если в объекте «Сертификат» указан объект «Доверенность», данные о доверенности будут передаваться в формализованные вложения для подготовки информации о подписанте. Если подписание происходит по МЧД и она оформлена в Saby, то достаточно передать только поле «ИдентификаторМЧД». Остальные данные заполнятся автоматически. Если в Saby информация об указанной МЧД отсутствует, то дополнительно передайте поля «СистемаХраненияМЧД», «ИННДоверителя» и «ДействительнаС».
Если в объекте «Доверенность» не передано значение «ИдентификаторМЧД», то считается, что передана информация о бумажной доверенности. В этом случае обязательны для заполнения поля «ВнутрНомер», «ИННДоверителя» и «ДействительнаС».
Если фамилия, имя или отчество подписанта состоит из нескольких раздельных слов, соедините их с помощью символа «_» (нижнее подчеркивание) и укажите в поле «Сертификат.ФИО». При передаче данных символы подчеркивания будут заменены на пробелы.
Сертификат будет выбран автоматически, если:
- в запросе не переданы реквизиты подписанта;
- в Saby доступны один или несколько серверных неквалифицированных сертификатов;
- регламент документооборота позволяет подписание неквалифицированными ключами.
Вызов «СБИС.ПодготовитьДействие» ведет к генерации (перегенерации) служебных документов и ответных титулов. Измененные или сгенерированные вложения имеют атрибут
«Документ.Вложение.Модифицирован»=«Да» . Другие методы модификацию не производят и возвращают «Документ.Этап.Вложение.Модифицирован»=«Нет».В ответе «СБИС.ПодготовитьДействие» поле с криптографическим хешем («Вложение.Файл.Хеш») возвращается только для тех вложений, которые изменены или требуют подписания.
Не используйте адресацию по названию этапов. Это может привести к ошибкам:
- будет подготовлена неверная редакция документа — при адресации по идентификатору документа на момент вызова метода может появиться новая редакция;
- может быть создан одноименный этап — если одноименные этапы были переназначены текущему или другому пользователю.
Алгоритм расчета криптографического хеша для подписываемых файлов определяется по данным сертификата, который зарегистрирован в личном кабинете. Чтобы определить сертификат, передайте поле «Отпечаток» в «Документ.Этап.Действие.Сертификат». Если «Отпечаток» отсутствует, хеш рассчитывается по ГОСТ Р 34.10-2012.
Поля «Документ.Идентификатор» или «Документ.Редакция.Идентификатор» обязательно должны быть заполнены. Если заполнено поле:
- «Документ.Идентификатор» — обрабатывается этап и действия последней редакции;
- «Документ.Редакция.Идентификатор» — этап и действия конкретной редакции.
Чтобы обработать отдельные файлы, в объекте «Документ» необходимо:
- передать в поле «ДопПоля» значение «СложноеУтверждение»;
- добавить идентификаторы обрабатываемых файлов в список «Вложение», если они в этом списке отсутствуют.
Если в реквизитах сертификата не заполнено поле «Отпечаток», для генерации служебных документов будут использованы реквизиты «ИНН», «ФИО», «Должность» и «ОГРНИП». Если ОГРНИП указан, то считается, что владелец сертификата — ИП, иначе — физическое лицо.