Присоединяйтесь!

СБИС.ПодготовитьДействие

СБИС.ПодготовитьДействие

Команда «СБИС.ПодготовитьДействие» подготавливает документ к переходу на следующий этап документооборота.

В формализованных документах метод:

  • указывает идентификаторы участников документооборота;
  • заполняет теги <Отправитель>, <Получатель>, <Подписант>;
  • формирует имя файла по формату.

Также «СБИС.ПодготовитьДействие» формирует извещения о получении и ответные документы, если этого требует регламент документооборота.

Адрес запроса: https://online.sbis.ru/service/?srv=1

Параметры запроса

* — обязательный параметр.

** — условно-обязательный параметр.

* — параметр для определения реквизитов при подписании, генерации и модификации документов.

Синий — только для чтения.

  • "Документ": объект:
    • "Идентификатор"*: строка
    • "Редакция": объект:
      • "Идентификатор"*: строка
    • "Этап"*: объект:
      • "Название"**: строка, обязательна при обработке служебного этапа
      • "Идентификатор"**: строка. Может быть пустой для действия «Отправить» этапа «Отправка»
      • "Действие"*: объект:
        • "Название"*: строка, список допустимых значений
        • "Комментарий"**: строка, обязательна не для всех действий
        • "Сертификат"**: объект. Обязательный, если этап подразумевает подписание документа, а также изменение или генерацию файлов
          • "ФИО"*: строка
          • "Должность"*: строка
          • "ИНН"*: строка, значение соответствует идентификационному номеру налогоплательщика
          • "ОГРНИП"*: строка
          • "КодСтраны": строка, код страны в стандарте ISO 3166-1 alpha-2
          • "Название": строка
          • "Отпечаток"*: строка
          • "Доверенность": массив объектов
            • "ИдентификаторМЧД": строка, 36-разрядный GUID из имени файла
            • "СистемаХраненияМЧД": строка
            • "ДействительнаС": дата и время начала действия доверенности
            • "ДействительнаПо": дата и время окончания действия доверенности
            • "ВнутрНомер": строка
            • "ИННДоверителя": строка
    • "Вложение": массив объектов (вложений документа для раздельной обработки):
      • "Идентификатор": строка, идентификатор вложения
    • "ДопПоля": строка, дополнительные параметры метода

Результат

Команда возвращает массив объектов со структурой:

  • "Документ": объект:
    • "Идентификатор": строка
    • "Направление": строка
    • "НашаОрганизация": объект:
      • ...
    • "Контрагент": объект:
      • ...
    • "Подразделение": объект:
      • ...
    • "Ответственный": объект:
      • ...
  • "Этап": массив объектов:
    • "Название": строка
    • "Идентификатор": строка
    • "Служебный": строка «Да»/«Нет»
    • "Действие": массив объектов:
      • "Название": строка
      • "ТребуетПодписания": строка «Да»/«Нет»
      • "ТребуетКомментария": строка «Да»/«Нет»
      • "Сертификат": массив объектов:
        • "ФИО": строка
        • "Должность": строка
        • "ИНН": строка, значение соответствует идентификационному номеру налогоплательщика
        • "КодСтраны": строка, код страны в стандарте ISO 3166-1 alpha-2
        • "ОГРНИП": строка
        • "Название": строка
        • "Отпечаток": строка
        • "Квалифицированный": строка «Да»/«Нет»
        • "ДействителенС": дата и время
        • "ДействителенПо>": дата и время
        • "Ключ": объект:
          • "Активирован": строка «Да»/«Нет»
          • "СпособАктивации": строка
          • "Тип": строка
    • "Вложение": массив объектов:
      • "Название": строка
      • "Идентификатор": строка
      • "Модифицирован": строка
      • "Файл": объект:
  • "Имя": строка
  • "Ссылка": строка
  • "Хеш": строка в Base64. Представляет собой криптографический хеш загруженных бинарных данных.

Комментарий

  1. Из поля «Отпечаток» объекта «Сертификат» извлекаются реквизиты данных, которые нужны для подготовки информации о подписанте в формализованных вложениях (ФИО, ИНН, Название, Должность, ОГРНИП и т.д.). Само значение отпечатка не сохраняется. Чтобы при закрытии этапа был использован нужный вам сертификат, обеспечьте его передачу в последующий вызов метода «СБИС.ВыполнитьДействие».

    Если в объекте «Сертификат» указан объект «Доверенность», данные о доверенности будут передаваться в формализованные вложения для подготовки информации о подписанте. Если подписание происходит по МЧД и она заведена в СБИС, то достаточно передать только поле «ИдентификаторМЧД». Остальные данные заполнятся автоматически. Если в СБИС информация об указанной МЧД отсутствует, то дополнительно передайте поля «СистемаХраненияМЧД», «ИННДоверителя» и «ДействительнаС».

    Поле «ИдентификаторМЧД» должно соответствовать формату 36-разрядного GUID. Иначе произойдет ошибка проверки входных данных.

    Если в блоке «Доверенность» не передано значение «ИдентификаторМЧД», то считается, что передана информация о бумажной доверенности. В этом случае обязательными для заполнения поля «ВнутрНомер», «ИННДоверителя» и «ДействительнаС».

  2. Если фамилия, имя или отчество подписанта состоит из нескольких раздельных слов, соедините их с помощью символа «_» (нижнее подчеркивание) и укажите в поле «Сертификат.ФИО». При передаче данных символы подчеркивания будут заменены на пробелы.

  3. Сертификат будет выбран автоматически, если:

    • в запросе не переданы реквизиты подписанта;
    • в СБИС доступен один или несколько серверных неквалифицированных сертификатов;
    • регламент документооборота позволяет подписание неквалифицированными ключами.
  4. Вызов «СБИС.ПодготовитьДействие» ведет к генерации (перегенерации) служебных документов и ответных титулов. Измененные или сгенерированные вложения имеют атрибут «Документ.Вложение.Модифицирован»=«Да». Другие методы модификацию не производят и возвращают «Документ.Этап.Вложение.Модифицирован»=«Нет».

    В ответе «СБИС.ПодготовитьДействие» поле с криптографическим хешем («Вложение.Файл.Хеш») возвращается только для тех вложений, которые изменены или требуют подписания.

  5. Не используйте адресацию по названию этапов. Этот способ допускает подготовку к этапу неверной редакции: при адресации по идентификатору документа на момент вызова метода может появиться новая редакция документа. Также может возникнуть одноименный этап, если аналогичные этапы были переназначены текущему или другому пользователю.

  6. Алгоритм расчета криптографического хеша для подписываемых файлов определяется по данным сертификата, который зарегистрирован в личном кабинете. Чтобы определить сертификат, передайте поле «Отпечаток» в «Документ.Этап.Действие.Сертификат». Если «Отпечаток» отсутствует, хеш рассчитывается по ГОСТ Р 34.10-2012.

  7. Поля «Документ.Идентификатор» или «Документ.Редакция.Идентификатор» обязательно должны быть заполнены. Если заполнено поле:

    • «Документ.Идентификатор» — обрабатывается этап и действия последней редакции;
    • «Документ.Редакция.Идентификатор» — этап и действия конкретной редакции.
  8. Чтобы обработать отдельные файлы, в объекте «Документ» необходимо:

    • передать в поле «ДопПоля» значение «СложноеУтверждение»;
    • добавить идентификаторы обрабатываемых файлов в список «Вложение», если они в этом списке отсутствуют.
  9. Если в реквизитах сертификата не заполнено поле «Отпечаток», для генерации служебных документов будут использованы реквизиты «ИНН», «ФИО», «Должность» и «ОГРНИП». Если ОГРНИП указан, то считается, что владелец сертификата — ИП, иначе — физическое лицо.

Пример запроса

Пример ответа

Пример раздельной обработки файлов

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.