Описание REST API

Доступные методы-API

Все запросы принимаются только в кодировке UTF-8. Ответ формируется в JSON-формате. Данные типа «Дата» указываются в формате Y-m-d (например 2014-03-21), данные типа «Дата/время» — в формате Y-m-d\TH:i:sP (например: 2014-03-21T05:14:07).
У приложения стоит ограничение на кол-во зпросов в секунду, не больше 4 (4 rps).
Авторизация производится любым из двух способов:

- с помощью http авторизации
- API-ключа, который передается заголовке X-Token

        
            https://www.vidal.ru/api/rest/v1/product/list

В случае отсутствия API-ключа либо в случае, если он неверный, API сообщает об ошибке.
Разрешается обращаться не чаще 3 запросов в секунду с одного IP. В случае более высокой нагрузки API будет отдавать ответ с ошибкой

Все параметры фильтрации обарачиваются в filter, пример запроса:

        
            https://www.vidal.ru/api/rest/v1/product/list?filter[name]=Аспирин&page=1&limit=100

Формат ответа

В случае ошибки в запросе помимо самого ответа присутствует информация об ошибке.

    
        https://www.vidal.ru/api/rest/v1/product/list?filter[name]=Аспирин&page=1&limit=not_valid
        {
            "success": false,
            "errorMsg": "Errors in the pagination parameters",  // Общее описание ошибки
            "errors": {                                         // Описание параметров
                "page": "Значение должно быть числом."
            }
        }

Пример запрос получения информации по штрихкоду

    
        https://www.vidal.ru/api/rest/v1/product/list?filter[barCode]=NNNNNNNNN

Новости

2024-02-07 Метод /api/rest/v1/product/list.{_format}
- Появился фильтр filter[analogsUpdatedAtFrom], filter[analogsUpdatedAtTo] см документацию
- Появился фильтр filter[barcodeUpdatedAtFrom], filter[barcodeUpdatedAtTo] см документацию
2023-10-05 Изменения в объекте Product, Document
- В объекте Product массово изменилось значение поля updateAt
- В объекте Document массово изменилось значение поля updateAt
2023-06-06 Изменения в объекте Product, ProductPackage
- В объекте Product появилось поле childrens - содержит дочерние продукты
- В объекте ProductPackage появилось поле productId - id связанного продукта
2023-03-03 Метод /api/rest/v1/product/list.{_format}
- Отказались от limit 250
2021-11-04 Метод /api/rest/v1/product/list.{_format}
- Отказались от limit 500, 1000 появлся 250 limit=250
2021-04-11 Метод /api/rest/v1/product/list.{_format}
- Изменена логика filter[updatedAtFrom], filter[updatedAtTo] Корректная логика
- Появился фильтр filter[productUpdatedAtFrom], filter[productUpdatedAtTo] см документацию
- Появился фильтр filter[documentUpdatedAtFrom], filter[documentUpdatedAtTo] см документацию
2021-04-07 Метод /api/rest/v1/product/list.{_format}
- В ответе появилось много новых полей см документацию