Документация

Последнее обновление: 27 Марта, 2019

Общее

Доступ к API осуществляется посредством HTTP-запросов и реализован с использованием принципов REST.

Базовый URI для веб-службы:

https://api.gpi24.ru/v1.0/

Обмен осуществляется в кодировке UTF-8.


API - Википедия REST - Википедия

Авторизация

Поддерживается только один способ авторизации:

  • передача ключа в GET-параметре key

Получить ключ-доступа можно в личном кабинете (чтобы страница стала доступной, необходимо запросить доступ через менеджера).

Для каждого клиента создается отдельный ключ.

Версионирование

С течением времени могут измениться как перечень запросов, так их структура и структура ответов.

Для уверенности в том, что используется API желаемой версии, необходимо передавать версию в строке запроса.

Итого запрос должен выглядеть следующим образом: /v[версия]/[путь_к_ресурсу]

Например:

https://api.gpi24.ru/v1.0/details/?key='key'

В случае, если версия не передана, будет возвращён ответ в формате, описанном в последней стабильной версии API.

Поддержка старых версий API cо временем может быть прекращена.

Перечень версий:
Версия Статус
1.0 Текущая

Коды ошибок API

Код Сообщение Описание
200 OK
400 Bad Request Некорректный запрос
401 Unauthorized Неавторизованный доступ
403 Forbidden Доступ запрещен
404 Not Found Данные не найдены
500 Internal server error Внутренняя ошибка сервера

Получение списка товаров по артикулу

Принцип работы:

Находим товар по заданному артикулу в поиске. В случае, если товар не найден или произошла какая-то ошибка, элемент STATUS будет иметь код ошибки, а элемент MESSAGE текст-описание ошибки.

Шаблон запроса:

https://api.gpi24.ru/v1.0/details/?article='article'&brand='brand'&key='key'

Входные параметры:
Имя Тип Обязательный Описание Примечание
article Строка Да Артикул article=w683
brand Строка Да Фильтр: Получение списка товара определенного бренда brand=bosch
key Строка Да Секретный ключ пользователя key=************
Выходные параметры:
Имя Тип Описание
status Строка Кодовое значение ответа сервера
message Строка Текстовое пояснение кода ответа сервера
answer Массив Ответ сервера на запрос
Ответ сервера на запрос:
Имя Тип Описание
CODE Число Код товара
ARTICLE Строка Артикул
BRAND Строка Бренд
DESCR Строка Описание
WAREHOUSE Строка Склад
DELIVERY Строка Доставка
BOX Число Количество
MIN Число Минимальное кол-во
PRICE Число Цена

Получение списка групп

Принцип работы:

Находим список брендов по запросу. В случае, если групп по запросу нет то, элемент STATUS будет иметь код ошибки, а элемент MESSAGE текст-описание ошибки.

Шаблон запроса:

https://api.gpi24.ru/v1.0/group/?search='search'&key='key'

Входные параметры:
Имя Тип Обязательный Описание Примечание
search Строка Да Артикул article=w683 mann-filter
key Строка Да Секретный ключ пользователя key=************
Выходные параметры:
Имя Тип Описание
status Строка Кодовое значение ответа сервера
message Строка Текстовое пояснение кода ответа сервера
answer Массив Ответ сервера на запрос
Ответ сервера на запрос:
Имя Тип Описание
article Строка Артикул
brand Строка Бренд
descr Строка Описание
price Число Примерная цена позиции
delivery Массив Доставка
delivery.day Число Кол-во дней доставки
delivery.descr Строка Наименование кол-ва дней доставки