CallSabyApi2 — различия между версиями
(Новая страница: «== Описание == Вызов метода основного сервиса == Параметры == * {{Шаблон:ApiParam|Method ||строка| наз…») |
|||
| (не показаны 4 промежуточные версии этого же участника) | |||
| Строка 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> | ||
| + | В поле params переданные параметры имеют определенное название. В нашем случае параметр с именем "Документ". Для CallSabyApi2 нет необходимости указывать имя параметра, достаточно передать его значение, но необходимо соблюдать порядок передаваемых параметров. Подробнее в примере ниже. | ||
== Параметры == | == Параметры == | ||
* {{Шаблон:ApiParam|Method ||строка| название метода для вызова }} | * {{Шаблон:ApiParam|Method ||строка| название метода для вызова }} | ||
| − | * {{Шаблон:ApiParam|Params|| | + | * {{Шаблон:ApiParam|Params||массив объектов| массив объектов с параметрами для вызова метода}} |
== Результат == | == Результат == | ||
* {{Шаблон:ApiParam|Result||объект| результат вызываемого метода }} | * {{Шаблон:ApiParam|Result||объект| результат вызываемого метода }} | ||
| Строка 13: | Строка 27: | ||
====Запрос==== | ====Запрос==== | ||
<source lang="json"> | <source lang="json"> | ||
| − | "Method": "СБИС. | + | "Method": "СБИС.ПрочитатьДокумент", |
| − | "Params": | + | "Params": |
| − | + | [ | |
| − | " | + | { |
| − | " | + | "Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163", |
| + | "ДопПоля": "ДополнительныеПоля" | ||
} | } | ||
| − | + | ] | |
</source> | </source> | ||
====Ответ==== | ====Ответ==== | ||
| Строка 25: | Строка 40: | ||
{ | { | ||
"Result": { | "Result": { | ||
| − | + | "Автор": { | |
| − | " | + | "Идентификатор": "", |
| − | " | + | "Имя": "Иван", |
| − | " | + | "Отчество": "Иванович", |
| + | "Фамилия": "Иванов" | ||
}, | }, | ||
| − | " | + | "Вложение": [], |
| + | ... | ||
}, | }, | ||
"Stat": ... | "Stat": ... | ||
Текущая версия на 16:13, 21 октября 2021
Содержание
Описание
Прокси метод, позволяющий вызывать методы API ЭДО через ExtSdk2. Например, в статье API СБИС.ПрочитатьДокумент указан успешный вызов метода
{
"jsonrpc": "2.0",
"method": "СБИС.ПрочитатьДокумент",
"params": {
"Документ": {
"Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
"ДопПоля": "ДополнительныеПоля"
}
},
"id": 0
}В поле params переданные параметры имеют определенное название. В нашем случае параметр с именем "Документ". Для CallSabyApi2 нет необходимости указывать имя параметра, достаточно передать его значение, но необходимо соблюдать порядок передаваемых параметров. Подробнее в примере ниже.
Параметры
- Method (строка) - название метода для вызова
- Params (массив объектов) - массив объектов с параметрами для вызова метода
Результат
- Result (объект) - результат вызываемого метода
- Stat (объект) - статистика времени выполнения операции
Исключения
Пример успешного вызова
Запрос
"Method": "СБИС.ПрочитатьДокумент",
"Params":
[
{
"Идентификатор": "f2a7c885-269a-44e4-8781-cb928df94163",
"ДопПоля": "ДополнительныеПоля"
}
]Ответ
{
"Result": {
"Автор": {
"Идентификатор": "",
"Имя": "Иван",
"Отчество": "Иванович",
"Фамилия": "Иванов"
},
"Вложение": [],
...
},
"Stat": ...
}