Внешние системы/Объекты метаданных/Управление номенклатурой: различия между версиями
(→Доступ) |
|||
(не показано 8 промежуточных версий этого же участника) | |||
Строка 8: | Строка 8: | ||
=Хранение данных= | =Хранение данных= | ||
==Доступ== | ==Доступ== | ||
Настройки доступа к | Настройки доступа к интерфейсу API внешней системы. | ||
; | ;Адрес | ||
*'''Протокол''' - http или https доступ к | *'''Протокол''' - http или https доступ к интерфейсу API; | ||
*'''Сервер''' - домен или IP адрес сервера; | *'''Сервер''' - домен или IP адрес сервера; | ||
*'''Порт''' - порт | *'''Порт''' - порт интерфейса API; | ||
*'''Путь''' - общий путь к | *'''Путь''' - общий путь к интерфейсу API. | ||
;Авторизация | ;Авторизация | ||
Строка 20: | Строка 20: | ||
**'''Basic''' - базовая аутентификация, логин и пароль передаются в web запросе; | **'''Basic''' - базовая аутентификация, логин и пароль передаются в web запросе; | ||
**'''Другая''' - логика авторизации прописана в модулей API. '''Используется в большинстве случаев'''. | **'''Другая''' - логика авторизации прописана в модулей API. '''Используется в большинстве случаев'''. | ||
*'''Пользователь''' - имя пользователя. Как правильно используется для '''Basic''' авторизации; | |||
*'''Пароль''' - пароль пользователя. Как правильно используется для '''Basic''' авторизации; | |||
*'''Токен''' - как правильно возможно получить в '''личном кабинете, через web интерфейс''', но могут быть и другие варианты, например генерируется администратором сервиса и отправляется электронным сообщением; | |||
*'''Идентификатор клиент''' - дополнительный параметр авторизации. Заполнять, либо нет зависит от особенностей API. | |||
;Таймаут | |||
Максимальное время ожидания ответа от API. | |||
==Обмен данными== | |||
Общие настройки обмена данными с внешней системой через API. | |||
;Владелец данных | |||
Ссылка на справочник [[Владельцы данных/Объекты метаданных/Управление номенклатурой|владельцев данных]], который будет использовать при загрузке данных. | |||
;Обработка API | |||
Модуль обработки с индивидуальными функциями, разработанный для конкретного API. Процедуры авторизации, запросов выгрузки и загрузки данных. | |||
[[Category:Объекты_метаданных]] | [[Category:Объекты_метаданных]] | ||
[[Category:Обмен_данными]] | [[Category:Обмен_данными]] | ||
[[Category:Инструменты]] | [[Category:Инструменты]] |
Текущая версия от 18:40, 2 октября 2022
Справочник общих настроек доступа к web интерфейсу API внешних систем.
Назначение
Общие настройки обмена данными через API внешних систем.
API разрабатываются индивидуально, и сделать какую то универсальную систему для обмена данными с любой API не получится. Но все таки часть, общих для любых API настроек выделить возможно, они и собраны в данном справочнике настроек.
Хранение данных
Доступ
Настройки доступа к интерфейсу API внешней системы.
- Адрес
- Протокол - http или https доступ к интерфейсу API;
- Сервер - домен или IP адрес сервера;
- Порт - порт интерфейса API;
- Путь - общий путь к интерфейсу API.
- Авторизация
Параметры доступа к web интерфейсу. Разрабатывается индивидуально, и алгоритм заложен в подключаемом модуле обмена данными (для каждого API свой), заполнять только параметры необходимые для конкретного API, какие именно смотреть в описании модуля доступа к конкретному API.
- Тип авторизации - варианты:
- Basic - базовая аутентификация, логин и пароль передаются в web запросе;
- Другая - логика авторизации прописана в модулей API. Используется в большинстве случаев.
- Пользователь - имя пользователя. Как правильно используется для Basic авторизации;
- Пароль - пароль пользователя. Как правильно используется для Basic авторизации;
- Токен - как правильно возможно получить в личном кабинете, через web интерфейс, но могут быть и другие варианты, например генерируется администратором сервиса и отправляется электронным сообщением;
- Идентификатор клиент - дополнительный параметр авторизации. Заполнять, либо нет зависит от особенностей API.
- Таймаут
Максимальное время ожидания ответа от API.
Обмен данными
Общие настройки обмена данными с внешней системой через API.
- Владелец данных
Ссылка на справочник владельцев данных, который будет использовать при загрузке данных.
- Обработка API
Модуль обработки с индивидуальными функциями, разработанный для конкретного API. Процедуры авторизации, запросов выгрузки и загрузки данных.