CallSabyApi — различия между версиями
| (не показано 6 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
== Описание == | == Описание == | ||
| − | + | Прокси метод, позволяющий вызывать методы [https://sbis.ru/help/integration/api/documents API ЭДО] через ExtSdk2. | |
| + | |||
| + | Ниже указан пример вызова [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||объект| результат вызываемого метода }} | ||
* {{Шаблон:ApiParam|Stat||объект|[[Stat_-_ExtSdk2_Объект|статистика времени выполнения операции]]}} | * {{Шаблон:ApiParam|Stat||объект|[[Stat_-_ExtSdk2_Объект|статистика времени выполнения операции]]}} | ||
| − | |||
== Пример успешного вызова == | == Пример успешного вызова == | ||
| + | |||
| + | CallSabyApi на вход принимает два параметра Method и Params. Для вызова через OLE Советуем обратиться к статье [[Подключение_к_ExtSdk2_через_OLE_-_Сценарии_ExtSdk2|Подключение к ExtSdk2##Получение и обработка событий]] к Шагу 4. | ||
====Запрос==== | ====Запрос==== | ||
<source lang="json"> | <source lang="json"> | ||
| − | "Method": "СБИС. | + | { |
| + | "Method": "СБИС.ПрочитатьДокумент", | ||
"Params": { | "Params": { | ||
| − | " | + | "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163", |
| − | + | "ДопПоля": "ДополнительныеПоля" | |
| − | + | } | |
| − | |||
| − | |||
</source> | </source> | ||
====Ответ==== | ====Ответ==== | ||
| Строка 26: | Строка 27: | ||
{ | { | ||
"Result": { | "Result": { | ||
| − | + | "Автор": { | |
| − | " | + | "Идентификатор": "", |
| − | " | + | "Имя": "Иван", |
| − | " | + | "Отчество": "Иванович", |
| + | "Фамилия": "Иванов" | ||
}, | }, | ||
| − | " | + | "Вложение": [], |
| + | ... | ||
}, | }, | ||
"Stat": ... | "Stat": ... | ||
Текущая версия на 11:26, 11 мая 2022
Описание
Прокси метод, позволяющий вызывать методы API ЭДО через ExtSdk2.
Ниже указан пример вызова СБИС.ПрочитатьДокумент. Обратите внимание, в СБИС.ПрочитатьДокумент в поле params переданные параметры имеют определенное название. В нашем случае параметр с именем "Документ". Для CallSabyApi нет необходимости указывать имя параметра, достаточно передать его значение, но все так же необходимо соблюдать порядок передаваемых параметров. Подробнее в примере ниже.
Параметры
- Method (строка) - название метода для вызова
- Params (объект) - объект с параметрами вызываемого метода API ЭДО
Результат
- Result (объект) - результат вызываемого метода
- Stat (объект) - статистика времени выполнения операции
Пример успешного вызова
CallSabyApi на вход принимает два параметра Method и Params. Для вызова через OLE Советуем обратиться к статье Подключение к ExtSdk2##Получение и обработка событий к Шагу 4.
Запрос
{
"Method": "СБИС.ПрочитатьДокумент",
"Params": {
"Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
"ДопПоля": "ДополнительныеПоля"
}Ответ
{
"Result": {
"Автор": {
"Идентификатор": "",
"Имя": "Иван",
"Отчество": "Иванович",
"Фамилия": "Иванов"
},
"Вложение": [],
...
},
"Stat": ...
}