QS: Спецодежда API | Руководство по интеграции

1. Общие сведения

1.1. Аутентификация

Аутентификации на сервере с API, происходит по токену, который предварительно необходимо получить в тех поддержке. Токены API привязаны к базе данных, поэтому если у вас несколько баз данных, вам необходимо получить по токену для каждой базы. Так же для разных интеграции лучше, лучше получать отдельные токены.

При обращении к серверу необходимо передавать заголовок аутентификации: Authorization: Bearer you-token

1.2. Версии

API версии v1 поддерживает версии программы начиная с 2.9. Для более ранних версий программы API не доступен.

1.3. Формат данных

API отдает данные в формате JSON. Не привязывайтесь к порядку следования записей в ответах API, он может меняться со временем.

Для многих полей значения может отсутствовать, в этом случае в качестве значения вернется null.

1.3.1. Формат даты

В параметрах запроса дату необходимо передавать в формате 'YYYY-MM-DD'.

В ответах API, если не указано иное дата как правило подставлена в формате ISO 8601-1:2019, то есть имеет следующий вид "2023-06-18T00:00:00".

2. Получение информации о выдачах

Запрос позволяет получить список произведенных выдач за период. Запрос не возвращает ручные операции, а так же возвраты и списания.

2.1. Параметры запроса

begin_date

Начало запрашиваемого периода выдач, включительно.

end_date

Конец запрашиваемого периода выдач, включительно.

2.2. Ответ

[
    {
        "id" : 1,
        "operation_time" : "2022-06-18T13:10:52",
        "employee" : {
            "id" : 667,
            "personnel_number": "5525",
            "last_name" : "Иванов",
            "first_name" : "Иван",
            "patronymic_name" : "Иванович"
        },
        "nomenclature": {
            "id": 4,
            "number": "1081", //Номенклатурный номер, артикул
            "name": "Вкладыши противошумные UVEX ИКС ФИТ ПИЧ"
        },
        "size": { //Для безразмерных номенклатур, значение будет null
            "id" : 42,
            "name": "52-54",
            "alternative_name": "104-108" // Название по ГОСТ, может отсутствовать
        },
        "height": { // Для позиций без роста, значение будет null
            "id": 18,
            "name": "194-200"
        },
        "issued": 1, //Количество выданного
        "nomenclature_of_norm": { //Номенклатура используемая в норме, может отсутствовать с случае выдачи не по норме.
            "id" : 5, //Id могут пресекаться с Id номенклатуры, это разные типы объектов
            "name": "Вкладыши противошумные"
        },
        "start_of_use": "2022-06-18T00:00:00",
        "expiry_by_norm": "2023-06-18T00:00:00",
        "norm_item" :{
            "id": 183,
            "amount": 1,
            "period_count": 36,
            "period_type": "Month" // Возможные варианты 'Year', 'Month', 'Shift', 'Wearout', 'Duty'
        },
        "issuance_sheet":{ //Номер и дата ведомости на выдачу. Может отсутствовать если не формировалась.
            "id": 12,
            "date": "2022-06-18T00:00:00"
        }
    },
    {
        //Следующая выдача
    }
]