API ACADEMIC помогает разработчикам создавать приложения и обмениваться информацией со сторонними информационными системами. Взаимодействие через API — получение список деталей по номеру, наличие оригиналов и аналогов на складах, поиск деталей и размещение заказов.

Алгоритм получения доступа:

1. Проинформируйте вашего персонального менеджера или обратитесь по общему номеру телефона, что нужно подключить API
2. Менеджер в течении 1-2 рабочих дней вам предоставит API ключ для подключения.

API построено на принципах REST с использованием HTTP и JSON для обмена информацией.

Документация по подключению:

[0.3.12] от 23/09/2024;

[0.3.11] от 16/09/2024;

[0.2.12] от 01/08/2024.

Описание сервиса apigate

Назначение: получение информации по номенклатуре и формирование заказов

Общие замечания: во всех случаях подразумевается использование кодировки UTF8

Шапка запросов должна содержать ключи

"Content-Type": "application/json"

"ApiKey": <токен>

На различные методы могут быть установлены ограничения на число запросов в единицу времени

Методы:

[GET]  /ping

Параметры:

Ответ:

200

Тело пустое

400-…

• data – пустая строка
• error – true
• errorText – строка с подробностями, могут присутствовать символы перевода строк (если причин несколько)

[GET]  /v1/brands

Параметры:

• br – энкодированная маска поиска брендов, поиск по принципу «начинается на» (например маска «vic» найдет “VICKERS”, “Victor-Reinz”, “Victor Reinz truck” и другие)

Ответ:

200

data – массив строк названий брендов

error – false

errorText – строка (пустая)

400-…

• data – пустая строка
• error – true
• errorText – строка с подробностями, могут присутствовать символы перевода строк (если причин несколько)

[GET]  /v1/articleBrands

Параметры:

• f – энкодированная маска поиска по коду производителя при этом учитываются только цифры и символы с кодами от 65 до 90 и с 1040 по 1071, при этом строка полученная после этих преобразований не должна быть менее 5 знаков

Ответ:

200

data – массив строк названий брендов

error – false

errorText – строка (пустая)

400-…

• data – пустая строка
• error – true
• errorText – строка с подробностями, могут присутствовать символы перевода строк (если причин несколько)

[GET]  /v1/filter

Параметры:

• f – энкодированная маска поиска по коду производителя при этом учитываются только цифры и символы с кодами от 65 до 90 и с 1040 по 1071, при этом строка полученная после этих преобразований не должна быть менее 5 знаков
• br – энкодированная строка брендов, полученных в методе /v1/brands, разделенных символом «_», параметр не обязателен

Ответ:

200

data – массив объектов вида

• nid – строка 50. Идентификатор номенклатуры
• storeID – строка 36. Идентификатор склада
• price – число 15.2. Цена
• vendorcode – строка 40, код производителя (в полном виде)
• note – наименование по системе источнику
• brand – строка 250, наименование бренда в системе источнике
• amount – число 15.0, свободный остаток
• deliverytime – число 3, срок поставки в днях

error – false

errorText – строка (пустая)

400-…

• data – пустая строка
• error – true
• errorText – строка с подробностями, могут присутствовать символы перевода строк (если причин несколько)

[POST] /v1/order

Схема тела запроса:

nset – массив

• nomenclatura – объект
• nid – строка (50) идентификатор номенклатуры из ответа метода /v1/filter
• storeportID – строка (36) идентификатор склада из метода /v1/filter
• amount   - число (15.0) количество запрашиваемой позиции

Ответ:

200

data

• ticket – строка с номером тикета для получения результата формирования заказа

error – false

errorText – строка (пустая)

400-…

• data – пустая строка
• error – true
• errorText – строка с подробностями, могут присутствовать символы перевода строк (если причин несколько)

[GET]  /v1/result

Параметры:

• sid – строка – значение поля ticket из ответа метода /v1/order

Ответ:

200

data

• sid – тикет задачи формирования заказа
• id – строка 36, идентификатор сформированного заказа по системе источнику
• total – число 15.2, сумма сформированного заказа

error – false

errorText – строка (пустая)

400-…

• data – пустая строка
• error – true
• errorText – строка с подробностями, могут присутствовать символы перевода строк (если причин несколько)

Если у Вас возникли проблемы с подключением API и нужна техподдержка, обратитесь к менеджеру — он свяжет вас с нашим техническим специалистом и окажет необходимую помощь.