xTrace: Описание Open API

Весь обмен документами между оператором НИС «Asl Belgisi» и участником оборота товаров осуществляется в электронном виде. 

Электронное взаимодействие c cистемой маркировки осуществляется по одному из двух вариантов:

• Предоставление сведений — обмен электронными документами, на основании которых могут вноситься изменения в реестры НИС «Asl Belgisi». Представление сведений является обязательным.

• Запрос сведений — обмен, при котором сведения из реестров НИС «Asl Belgisi» предоставляются участникам в соответствии с установленными разрешениями на получение сведений. При этом изменения в реестры не вносятся. Запрос и последующее представление сведений из системы маркировки инициируется участником по своему усмотрению и применяется, например, для проверки статусов кодов маркировки или статуса регистрации участника.

Для юридически значимых электронных документов применяется электронная цифровая подпись. Электронное взаимодействие осуществляется с применением программных интерфейсов взаимодействия (API) НИС «Asl Belgisi» и информационных систем участников оборота товаров.

При взаимодействии через API выполняются следующие требования:

• Аутентификация и авторизация участника (определение полномочий на осуществление электронного взаимодействия) осуществляется при помощи ЭЦП.

• При предоставлении и запросе сведений, защита передаваемых данных выполняется с применением протокола TLS/HTTPS шифрованием канала передачи данных сертифицированными средствами криптографической защиты информации.

Open API предназначен для взаимодействия участников оборота товаров (УОТ) с Информационной системой цифровой маркировки и позволяет выполнять следующие операции с кодами маркировки (КМ):

• получение перечня КМ;

• получение публичной и детальной информации о КМ;

• проверка регистрации контрагента;

• отправка и рассмотрение запроса на передачу КМ;

• формирование и расформирование АИК;

• агрегация и дезагрегация КИТУ;

• проверка описаний (карточек) товаров.

Начиная с версии документа v.1.7.2, разрешена отправка API-запросов для методов ICOM с использованием API-ключа бизнес-пользователя.
В связи с этим добавлена возможность работы в следующих операциях:

• работа с заказами КМ;

• работа с отчетами;

• просмотр и подача документов.

Для взаимодействия с Open API от имени УОТ рекомендуется создать API-ключ с типом bearerToken, который используется в заголовке Authorization.
Требования и порядок его создания представлены в статье «Создание API-ключа».

Основные изменения по сравнению с True API:

• изменена схема авторизации;

• изменена схема отправки запросов и получения ответов;

• обновлён справочник возвращаемых параметров.

В методе public/api/cod/private/codes расширен состав возвращаемых данных — теперь он включает большинство значений, которые ранее были доступны только через дополнительные параметры.

В случае отсутствия необходимых прав (то есть когда отправитель запроса не является текущим владельцем искомого кода), запрос к public/api/cod/private/codes автоматически перенаправляется на метод public/api/cod/public/codes.

Схема авторизации с 25.08.2025

Скачать документацию ⬇️