CallSabyApi — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
 
== Описание ==
 
== Описание ==
Прокси метод, позволяющий вызывать методы [https://sbis.ru/help/integration/api/documents API ЭДО] через ExtSdk2. Необходимо передать имя метода и его параметры без верхнего уровня. Например, в статье API [https://sbis.ru/help/integration/api/all_methods/read_doc СБИС.ПрочитатьДокумент] указан успешный вызов метода
+
Прокси метод, позволяющий вызывать методы [https://sbis.ru/help/integration/api/documents API ЭДО] через ExtSdk2.  
<source lang="json">
 
{
 
  "jsonrpc": "2.0",
 
  "method": "СБИС.ПрочитатьДокумент",
 
  "params": {
 
      "Документ": {
 
        "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
 
        "ДопПоля": "ДополнительныеПоля"
 
      }
 
  },
 
  "id": 0
 
}
 
</source>
 
  
то необходимо в CallSabyApi передать значения из полей "method" и "params" БЕЗ внутреннего верхнего уровня "Документ". Более подробно в примере ниже.
+
Ниже указан пример вызова [https://sbis.ru/help/integration/api/all_methods/read_doc СБИС.ПрочитатьДокумент]. Обратите внимание, в [https://sbis.ru/help/integration/api/all_methods/read_doc СБИС.ПрочитатьДокумент] в поле params переданные параметры имеют определенное название. В нашем случае параметр с именем "Документ". Для CallSabyApi нет необходимости указывать имя параметра, достаточно передать его значение, но все так же необходимо соблюдать порядок передаваемых параметров. Подробнее в примере ниже.
  
 
== Параметры ==
 
== Параметры ==
 
* {{Шаблон:ApiParam|Method ||строка| название метода для вызова }}
 
* {{Шаблон:ApiParam|Method ||строка| название метода для вызова }}
* {{Шаблон:ApiParam|Params||объект| объект с параметрами для вызова метода}}
+
* {{Шаблон:ApiParam|Params||объект| объект с параметрами вызываемого метода [https://sbis.ru/help/integration/api/documents API ЭДО]  }}
 
== Результат ==
 
== Результат ==
 
* {{Шаблон:ApiParam|Result||объект| результат вызываемого метода }}
 
* {{Шаблон:ApiParam|Result||объект| результат вызываемого метода }}
Строка 25: Строка 12:
  
 
== Пример успешного вызова ==
 
== Пример успешного вызова ==
 +
 +
CallSabyApi на вход принимает два параметра Method и Params. Для вызова через OLE Советуем обратиться к статье [[Подключение_к_ExtSdk2_через_OLE_-_Сценарии_ExtSdk2|Подключение к ExtSdk2##Получение и обработка событий]] к Шагу 4.
 
====Запрос====
 
====Запрос====
 
<source lang="json">
 
<source lang="json">
Строка 32: Строка 21:
 
       "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
 
       "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
 
       "ДопПоля": "ДополнительныеПоля"
 
       "ДопПоля": "ДополнительныеПоля"
  }
 
 
}
 
}
 
</source>
 
</source>

Текущая версия на 11:26, 11 мая 2022

Описание

Прокси метод, позволяющий вызывать методы API ЭДО через ExtSdk2.

Ниже указан пример вызова СБИС.ПрочитатьДокумент. Обратите внимание, в СБИС.ПрочитатьДокумент в поле params переданные параметры имеют определенное название. В нашем случае параметр с именем "Документ". Для CallSabyApi нет необходимости указывать имя параметра, достаточно передать его значение, но все так же необходимо соблюдать порядок передаваемых параметров. Подробнее в примере ниже.

Параметры

  • Method (строка) - название метода для вызова
  • Params (объект) - объект с параметрами вызываемого метода API ЭДО

Результат

Пример успешного вызова

CallSabyApi на вход принимает два параметра Method и Params. Для вызова через OLE Советуем обратиться к статье Подключение к ExtSdk2##Получение и обработка событий к Шагу 4.

Запрос

{
   "Method": "СБИС.ПрочитатьДокумент",
   "Params": {
      "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
      "ДопПоля": "ДополнительныеПоля"
}

Ответ

{
  "Result": {
       "Автор": {
         "Идентификатор": "",
         "Имя": "Иван",
         "Отчество": "Иванович",
         "Фамилия": "Иванов"
      },
      "Вложение": [],
      ...
  }, 
  "Stat": ...
}