API (Кинт) — различия между версиями
(Новая страница: «Категория:Обмен данными (КУС)») |
м |
||
| Строка 1: | Строка 1: | ||
[[Категория:Обмен данными (КУС)]] | [[Категория:Обмен данными (КУС)]] | ||
| + | == Общее == | ||
| + | При вызове любой операции необходимо передать имя метода - это предопределенный параметр http-запроса Method. | ||
| + | |||
| + | Ответ в формате JSON, Content-Type: application/json;charset=utf-8 | ||
| + | |||
| + | Ответ содержит два поля: Success - флаг успешности выполнения и Result - результат выполнения, обычно структура. | ||
| + | |||
| + | ;Вызов GET запроса: | ||
| + | :http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ИмяМетода | ||
| + | ;Вызов POST запроса: | ||
| + | :http://127.0.0.1/имя_публикации/hs/KintAPI.hs/PostData?Method=ИмяМетода | ||
| + | |||
| + | Пример ответа с ошибкой: | ||
| + | <pre> | ||
| + | { | ||
| + | "Success": false, | ||
| + | "Result": { | ||
| + | "Error": "Метод конфигурации <ИмяМетода> не найден!" | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | Для поиска любых ссылочных объектов используется одно из ключевых полей: ID или GUID. | ||
| + | ID - это навигационная ссылка на объект в базе 1С: Предприятия (e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc), а GUID - это уникальный идентификатор ссылки (49fde0fc-bb04-11e8-b458-5404a66e4a89). | ||
| + | При передаче параметров в запросах достаточно указать одно из этих полей: ?RoomCategory=[{"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc"}, {"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc"}] | ||
| + | Если в параметрах переданы оба поля, приоритет за полем ID. Следует учесть, что поиск по ID примерно на 50% быстрее поиска по GUID. | ||
| + | |||
| + | Файлы приложений передаются в формате base64. | ||
Версия 10:17, 18 сентября 2018
Общее
При вызове любой операции необходимо передать имя метода - это предопределенный параметр http-запроса Method.
Ответ в формате JSON, Content-Type: application/json;charset=utf-8
Ответ содержит два поля: Success - флаг успешности выполнения и Result - результат выполнения, обычно структура.
- Вызов GET запроса
- http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ИмяМетода
- Вызов POST запроса
- http://127.0.0.1/имя_публикации/hs/KintAPI.hs/PostData?Method=ИмяМетода
Пример ответа с ошибкой:
{
"Success": false,
"Result": {
"Error": "Метод конфигурации <ИмяМетода> не найден!"
}
}
Для поиска любых ссылочных объектов используется одно из ключевых полей: ID или GUID. ID - это навигационная ссылка на объект в базе 1С: Предприятия (e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc), а GUID - это уникальный идентификатор ссылки (49fde0fc-bb04-11e8-b458-5404a66e4a89). При передаче параметров в запросах достаточно указать одно из этих полей: ?RoomCategory=[{"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc"}, {"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc"}] Если в параметрах переданы оба поля, приоритет за полем ID. Следует учесть, что поиск по ID примерно на 50% быстрее поиска по GUID.
Файлы приложений передаются в формате base64.
