Внешние системы/Объекты метаданных/Управление номенклатурой
Справочник общих настроек доступа к 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.