Интеграция с информационной системой

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

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

Команда СБИС.ПодготовитьДействие подготавливает документ к переходу на следующий этап документооборота: в формализованных документах заполняет идентификаторы участников документооборота и теги <Отправитель>, <Получатель>, <Подписант>, формирует правильное (по формату) имя файла и, если требуется, генерирует извещения о получении и ответные документы.

Адрес для выполнения запроса: https://online.sbis.ru/service/?srv=1

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

  • "Документ": объект:
    • "Идентификатор"*: строка
    • Редакция": объект:
      • "Идентификатор"*: строка
    • "Этап"*: объект:
      • "Название"*: строка, обязательна при обработке служебного этапа
      • "Идентификатор"*: строка, обязательна для всех этапов. Может быть пустой для действия "Отправить" этапа "Отправка"
      • "Действие"*: объект:

Результат запроса

Синие — параметры, возвращаемые с сервера (поля, доступные только для чтения).

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

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

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

Внимание!

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

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

Комментарий

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

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

Cертификат будет выбран автоматически, если на вход функции «СБИС.ПодготовитьДействие»:

  • не передавались реквизиты подписанта;
  • есть один/несколько доступных серверных неквалифицированных сертификатов;
  • регламент документооборота позволяет использовать подписание неквалифицированными ключами.

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

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

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

Рекомендуется передавать идентификатор этапа и идентификатор редакции.

Настройки прав доступа

Для выполнение команды СБИС.ПодготовитьДействие у пользователя внешнего API-интерфейса в кабинете СБИС должны быть настроены права на изменение документов (уровень доступа «Полный» или «Администрирование»).

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

Пример ответа (успех)