СПРАВОЧНИК КОМАНД API-ИНТЕРФЕЙСА

Справочник команд API-интерфейса

Аутентификация и завершение работы

Работа с электронными документами

  • СБИС.ЗаписатьДокумент
    Создает в СБИС документ, либо его редакцию. Обновляет реквизиты уже существующего документа или вложения к документу.
  • СБИС.ПрочитатьДокумент
    Возвращает последнюю редакцию документа с заданным идентификатором, либо редакцию документа с задананным идентификатором редакции.
  • СБИС.ПодготовитьДействие
    Подготавливает документ к выполнению перехода на следующий этап документооборота: в формализованных документах заполняет идентификаторы участников документооборота и теги <Отправитель>, <Получатель>, <Подписант>, формирует правильное (по формату) имя файла, если требуется, генерирует извещения о получении и ответные документы.
  • СБИС.ВыполнитьДействие
    Выполняет для документа указанный переход с выбранного этапа документооборота. Если переход предполагает подписание документов, предварительно загружает подписи к вложениям, если подписание производится в информационной системе ключом на носителе.
  • СБИС.ИнформацияОСлужебныхЭтапах
    Возвращает количество необработанных извещений о получении.
  • СБИС.СписокСлужебныхЭтапов
    Возвращает список необработанных извещений о получении.
  • СБИС.СписокИзменений
    Возвращает список документов, по которым произошли события документооборота за указанный период времени.
  • СБИС.УдалитьДокумент
    Устанавливает у документа флаг "удален". Если документооборот не завершён, вторая сторона документооборота получает уведомление об удалении и документооборот завершается на обеих сторонах.
  • СБИС.СписокДокументов
    Возвращает список документов указанного типа («Реализация», «Корреспонденция» и т.д.). 
  • СБИС.СписокДокументовПоСобытиям
    Возвращает список документов реестра «Входящие», «Исходящие» или «Ответы от контрагентов».
  • СБИС.УничтожитьДокумент
    Удаляет документ без возможности его восстановления.
  • СБИС.ВосстановитьДокумент
    Восстанавливает документ, который ранее был помещен в корзину после вызова метода СБИС.УдалитьДокумент.

Работа с контрагентами и нашими организациями

  • СБИС.СписокНашихОрганизаций
    Возвращает список наших организаций и для каждой из них статус, подключен или нет документооборот.
  • СБИС.ИнформацияОКонтрагенте
    Возвращает по ИНН/КПП информацию о контрагенте, в том числе идентификатор участника документооборота. Если контрагент не найден, он будет добавлен в список и реквизиты заполнены по данным сервиса проверки партнеров.

​Регистрация пользователей

  • СБИС.ДобавитьПользователя
    Добавляет пользователя и связывает с указанным сертификатом, назначает пользователю права минимальные из всех имеющихся в кабинете + роль «Редактирование документов».

Управление сотрудниками

Действия с сертификатами электронной подписи

  • СБИС.ПроверитьСертификаты
    Возвращает статус сертификатов.
  • СБИС.ПолучитьКодАктивацииСертификата
    Используется для ключей, для которых установлена защита от несанкционированного доступа одноразовыми паролями по смс. Запрашивает отправку смс-сообщения с паролем.
  • СБИС.АктивироватьСертификат
    Используется для ключей, для которых установлена защита от несанкционированного доступа. Команда передает в СБИС код активации для ключа: постоянный пин-код (его можно задать явно в передаваемых параметрах) или одноразовый пароль (в информационной системе должен быть реализован интерфейс для его ввода).
  • СБИС.СписокСертификатов
    Возвращает список действительных сертификатов, собственных и делегированных, в соответствии с заданными условиями.
  • СБИС.Расшифровать
    Расшифровывает файл доступным сертификатом.

Сервисные функции

1
0
Оставьте свой отзыв:
ОТПРАВИТЬ