Внешние системы/Объекты метаданных/Управление номенклатурой: различия между версиями

Материал из Метадата
Перейти к навигации Перейти к поиску
 
(не показано 12 промежуточных версий этого же участника)
Строка 1: Строка 1:
Справочник общих настроек доступа к API внешних систем.
Справочник общих настроек доступа к web интерфейсу API внешних систем.


=Назначение=
=Назначение=
Строка 8: Строка 8:
=Хранение данных=
=Хранение данных=
==Доступ==
==Доступ==
Настройки доступа к web интерфейсу API внешней системы.
Настройки доступа к интерфейсу API внешней системы.
;Web адрес
;Адрес
*'''Протокол''' - http или https доступ к web интерфейсу API;
*'''Протокол''' - http или https доступ к интерфейсу API;
*'''Сервер''' - домен или IP адрес сервера;
*'''Сервер''' - домен или IP адрес сервера;
*'''Порт''' - порт web интерфейса API;
*'''Порт''' - порт интерфейса API;
*'''Путь''' - общий путь к web интерфейсу API.
*'''Путь''' - общий путь к интерфейсу API.
 
;Авторизация
Параметры доступа к web интерфейсу. Разрабатывается индивидуально, и алгоритм заложен в подключаемом модуле обмена данными (для каждого API свой), заполнять только параметры необходимые для конкретного API, какие именно смотреть в описании модуля доступа к конкретному API.
*'''Тип авторизации''' - варианты:
**'''Basic''' - базовая аутентификация, логин и пароль передаются в web запросе;
**'''Другая''' - логика авторизации прописана в модулей 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. Процедуры авторизации, запросов выгрузки и загрузки данных.

Источник — http://wiki.metadata24.com/index.php?title=Внешние_системы/Объекты_метаданных/Управление_номенклатурой&oldid=613