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