CallSabyApi — различия между версиями
Строка 1: | Строка 1: | ||
== Описание == | == Описание == | ||
− | + | Прокси метод, позволяющий вызывать методы [https://sbis.ru/help/integration/api/documents API ЭДО] через ExtSdk2. Необходимо передать имя метода и его параметры без верхнего уровня. Например, в статье API [https://sbis.ru/help/integration/api/all_methods/read_doc СБИС.ПрочитатьДокумент] указан успешный вызов метода | |
+ | <source lang="json"> | ||
+ | { | ||
+ | "jsonrpc": "2.0", | ||
+ | "method": "СБИС.ПрочитатьДокумент", | ||
+ | "params": { | ||
+ | "Документ": { | ||
+ | "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163", | ||
+ | "ДопПоля": "ДополнительныеПоля" | ||
+ | } | ||
+ | }, | ||
+ | "id": 0 | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | то необходимо в CallSabyApi передать значения из полей "method" и "params" БЕЗ внутреннего верхнего уровня "Документ". Более подробно в примере ниже. | ||
+ | |||
== Параметры == | == Параметры == | ||
* {{Шаблон:ApiParam|Method ||строка| название метода для вызова }} | * {{Шаблон:ApiParam|Method ||строка| название метода для вызова }} | ||
Строка 7: | Строка 23: | ||
* {{Шаблон:ApiParam|Result||объект| результат вызываемого метода }} | * {{Шаблон:ApiParam|Result||объект| результат вызываемого метода }} | ||
* {{Шаблон:ApiParam|Stat||объект|[[Stat_-_ExtSdk2_Объект|статистика времени выполнения операции]]}} | * {{Шаблон:ApiParam|Stat||объект|[[Stat_-_ExtSdk2_Объект|статистика времени выполнения операции]]}} | ||
− | |||
== Пример успешного вызова == | == Пример успешного вызова == | ||
====Запрос==== | ====Запрос==== | ||
<source lang="json"> | <source lang="json"> | ||
− | "Method": "СБИС.ПрочитатьДокумент" | + | "Method": "СБИС.ПрочитатьДокумент" |
"Params": { | "Params": { | ||
"Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163", | "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163", |
Версия 17:03, 20 октября 2021
Описание
Прокси метод, позволяющий вызывать методы API ЭДО через ExtSdk2. Необходимо передать имя метода и его параметры без верхнего уровня. Например, в статье API СБИС.ПрочитатьДокумент указан успешный вызов метода
{
"jsonrpc": "2.0",
"method": "СБИС.ПрочитатьДокумент",
"params": {
"Документ": {
"Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
"ДопПоля": "ДополнительныеПоля"
}
},
"id": 0
}
то необходимо в CallSabyApi передать значения из полей "method" и "params" БЕЗ внутреннего верхнего уровня "Документ". Более подробно в примере ниже.
Параметры
- Method (строка) - название метода для вызова
- Params (объект) - объект с параметрами для вызова метода
Результат
- Result (объект) - результат вызываемого метода
- Stat (объект) - статистика времени выполнения операции
Пример успешного вызова
Запрос
"Method": "СБИС.ПрочитатьДокумент"
"Params": {
"Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
"ДопПоля": "ДополнительныеПоля"
}
Ответ
{
"Result": {
"Автор": {
"Идентификатор": "",
"Имя": "Иван",
"Отчество": "Иванович",
"Фамилия": "Иванов"
},
"Вложение": [],
...
},
"Stat": ...
}