Назначение
Общие настройки обмена данными через API внешних систем.
API разрабатываются индивидуально, и сделать какую то универсальную систему для обмена данными с любой API не получится. Но все таки часть, общих для любых API настроек выделить возможно, они и собраны в данном справочнике настроек.
Формы
Ссылка: e1cib/list/Справочник.apiВнешниеСистемы
Форма элемента
Основная форма создание и редактирование элемента данных.
Реквизит
|
Описание
|
Тип значения
|
Наименование
|
Представление записи при просмотре в списках, и выбранных значениях реквизитов.
|
Строка(150)
|
Код
|
Уникальный идентификатор записи, для поиска в списках и при выборе значений
|
Строка(9)
|
Родитель
|
Ссылка на элемент родитель.
|
Внешние системы
|
Доступ
Реквизит
|
Описание
|
Тип значения
|
Протокол
|
http или https доступ к интерфейсу API
|
Строка(5)
|
Сервер
|
Домен или IP адрес сервера
|
Строка(40)
|
Порт
|
Порт интерфейса API
|
Число(10, 0)
|
Путь
|
Общий путь к интерфейсу API
|
Строка(200)
|
Тип авторизации
|
Тип авторизации для доступа к внешншей системе
|
Тип авторизации
|
Пользователь
|
Имя пользователя. Как правильно используется для Basic авторизации
|
Строка(40)
|
Пароль
|
Пароль пользователя. Как правильно используется для Basic авторизации
|
Строка(40)
|
Токен
|
Как правильно возможно получить в личном кабинете, через web интерфейс, но могут быть и другие варианты, например генерируется администратором сервиса и отправляется электронным сообщением
|
Строка(300)
|
Идентификатор клиента
|
Дополнительный параметр авторизации. Заполнять, либо нет зависит от особенностей API
|
Строка(50)
|
Таймаут
|
Максимальное время ожидания ответа от API
|
Число(10, 0)
|
Обмен данными
Реквизит
|
Описание
|
Тип значения
|
Владелец данных
|
Владелец загружемых из внешней системы данных
|
Владельцы данных
|
Обработка API
|
Модуль с функциями подключения, отправки данных и обработки ответа от API внешней системы
|
Специальные обработки
|
Форма списка
Основная форма просмотра списка данных.
Форма выбора
Основная Форма выбора элемента данных.
Форма группы
Основная форма создания и редактирования группы данных.
Реквизит
|
Описание
|
Тип значения
|
Наименование
|
Представление записи при просмотре в списках, и выбранных значениях реквизитов.
|
Строка(150)
|
Код
|
Уникальный идентификатор записи, для поиска в списках и при выборе значений
|
Строка(9)
|
Родитель
|
Ссылка на элемент родитель.
|
Внешние системы
|
Форма выбора группы
Основная Форма выбора группы данных.
Метаданные
Данные
Реквизиты
Синоним
|
Имя
|
Тип значения
|
Описание
|
Код
|
Код
|
Строка(9)
|
-
|
Наименование
|
Наименование
|
Строка(150)
|
-
|
Родитель
|
Родитель
|
Справочники: Внешние системы
|
-
|
Это группа
|
ЭтоГруппа
|
Булево
|
-
|
Сервер
|
Сервер
|
Строка(40)
|
Домен или IP адрес сервера
|
Порт
|
Порт
|
Число(10, 0)
|
Порт интерфейса API
|
Пользователь
|
Пользователь
|
Строка(40)
|
Имя пользователя. Как правильно используется для Basic авторизации
|
Пароль
|
Пароль
|
Строка(40)
|
Пароль пользователя. Как правильно используется для Basic авторизации
|
Протокол
|
Протокол
|
Строка(5)
|
http или https доступ к интерфейсу API
|
Путь
|
Путь
|
Строка(200)
|
Общий путь к интерфейсу API
|
Токен
|
Токен
|
Строка(300)
|
Как правильно возможно получить в личном кабинете, через web интерфейс, но могут быть и другие варианты, например генерируется администратором сервиса и отправляется электронным сообщением
|
Владелец данных
|
ВладелецДанных
|
Справочники: Владельцы данных
|
Владелец загружемых из внешней системы данных
|
Обработка API
|
ОбработкаAPI
|
Справочники: Специальные обработки
|
Модуль с функциями подключения, отправки данных и обработки ответа от API внешней системы
|
Таймаут
|
Таймаут
|
Число(10, 0)
|
Максимальное время ожидания ответа от API
|
Идентификатор клиента
|
ИдентификаторКлиента
|
Строка(50)
|
Дополнительный параметр авторизации. Заполнять, либо нет зависит от особенностей API
|
Тип авторизации
|
ТипАвторизации
|
Перечисления: Тип авторизации
|
Тип авторизации для доступа к внешншей системе
|
Подсистемы