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

Материал из razgovorov.ru
Перейти к: навигация, поиск
Строка 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. Например, в статье API [https://sbis.ru/help/integration/api/all_methods/read_doc СБИС.ПрочитатьДокумент] указан успешный вызов метода
 
<source lang="json">
 
<source lang="json">
 
{
 
{
Строка 14: Строка 14:
 
}
 
}
 
</source>
 
</source>
 
+
В поле params переданные параметры имеют определенное название. В нашем случае параметр с именем "Документ". Для CallSabyApi нет необходимости указывать имя параметра, достаточно передать его значение, но все так же необходимо соблюдать порядок передаваемых параметров. Подробнее в примере ниже.
то необходимо в CallSabyApi передать значения из полей "method" и "params" БЕЗ внутреннего верхнего уровня "Документ". Более подробно в примере ниже.
 
  
 
== Параметры ==
 
== Параметры ==

Версия 18:15, 20 октября 2021

Описание

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

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

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

Параметры

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

Результат

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

Запрос

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

Ответ

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