API бренды (Brand)

Добавление бренда, метод: /api/brand/add/

Параметры

Пример:

http://myboxurl/api/brand/add/?login=LOGIN&password=PASSWORD&name=TestBrand&code=123&image=url_image_in_this_place&deskription=Описание

Поле Тип Описание Обязательное или нет Комментарий
1 login string Логин в системе BOX Обязательное поле.  
2 password string Пароль в формате md5 Обязательное поле. Напишите в техподдержку и мы выдадим вам hash для API
3 name string Название бренда Обязательное поле.  
4 code string id бренда из вашей системы Не обязательное поле. Это уникальный идентификатор бренда из вашей системы(из вашего магазина). Если бренд с таким id существует, то API выдаст ошибку
7 image array массив изображений бренда Не обязательное поле. Изображения следует передавать массивом с указанием полного пути к ним. Система работает с такими форматами изображений: jpg, png
8 hidden boolean скрытый бренд Не обязательное поле. По умолчанию, бренд не является скрытым (hidden=0)
5 description string описание бренда Не обязательное поле.  

Удаление бренда, метод: /api/brand/delete/

Параметры

Пример:

http://myboxurl/api/brand/delete/?login=LOGIN&password=PASSWORD&code=123&id=321

Поле Тип Описание Обязательное или нет Комментарий
1 login string Логин в системе BOX Обязательное поле.  
2 password string Пароль в формате md5 Обязательное поле. Напишите в техподдержку и мы выдадим вам hash для API
3 id integer Идентификатор бренда или id или code бренда обязательно Код бренда в системе BOX
4 code string Идентификатор бренда Идентификатор бренда из вашей системы(из вашего магазина)

Редактирование бренда, метод: /api/brand/update/

Параметры

Пример:

http://myboxurl/api/brand/update/?login=LOGIN&password=PASSWORD&code=1234&name=TestBrand&hidden=1

Поле Тип Описание Обязательное или нет Комментарий
1 login string Логин в системе BOX Обязательное поле.  
2 password string Пароль в формате md5 Обязательное поле. Напишите в техподдержку и мы выдадим вам hash для API
3 id integer Идентификатор бренда или id или code бренда обязательно Код бренда в системе BOX
4 code string Идентификатор бренда Идентификатор бренда из вашей системы(из вашего магазина)
5 name string Название бренда Обязательное поле.  
6 description string описание бренда Не обязательное поле.  
8 image array массив изображений бренда Не обязательное поле. Изображения следует передавать массивом с указанием полного пути к ним. Система работает с такими форматами изображений: jpg, png
9 hidden boolean скрытый бренд Не обязательное поле. По умолчанию, бренд не является скрытым (hidden=0)

Получение одного бренда и получение всех брендов, метод: /api/brand/get/

Параметры
Параметры получения одного заказа:

Пример:

http://myboxurl/api/brand/get/?login=LOGIN&password=PASSWORD&name=TestBrand

Поле Тип Описание Обязательное или нет Комментарий
1 login string Логин в системе BOX Обязательное поле.  
2 password string Пароль в формате md5 Обязательное поле. Напишите в техподдержку и мы выдадим вам hash для API
3 name string Название бренда name или id или code бренда обязательно Если вам нужен конкретный бренд, то вы в это поле передаёте имя бренда, либо id бренда которое вернуло вам наше API при его создании. Или же указываете внешний идентификатор бренда(поле code при создании бренда) и движок сам найдёт и вёрнёт его.

Значения возвращаемых полей
id - id бренда,
name - Название бренда,
code - внешний id бренда,
image - массив изображений бренда,
description - описание бренда,
hidden - скрытый бренд
4 id integer Идентификатор бренда
4 code string Идентификатор бренда


Параметры получения всех заказов:

Пример:

http://myboxurl/api/brand/get/?login=LOGIN&password=PASSWORD

Поле Тип Описание Обязательное или нет Комментарий
1 login string Логин в системе BOX Обязательное поле.  
2 password string Пароль в формате md5 Обязательное поле. Напишите в техподдержку и мы выдадим вам hash для API
          Значения возвращаемых полей
id - id бренда,
name - Название бренда,
code - внешний id бренда,
image - массив изображений бренда,
description - описание бренда,
hidden - скрытый бренд

Возможные варианты ответа на запрос

Подробнее
Статус Сообщение Описание сообщения
1 ok brandid Возвращает id добавленного бренда
2 fail Login is empty! Отсутствует логин
3 fail Password is empty! Отсутствует пароль
4 fail Brand name is empty! Отсутствует название бренда
5 fail Bad user level! Недостаточный уровень юзера (нужен level 2 и выше)
6 fail Login or password not correct! Логин или пароль введены неверно
7 fail Brand with this ID already exists! Бренд с таким id уже существует
8 fail Incorrect picture! Некорректный формат изображения
9 fail Brand has not been added Бренд не был добавлен
10 fail Brand is not available for delete! Бренд для удаления не найден
11 fail Brand with this ID does not exists! Бренда с таким ID не существует
12 fail Brand with this Code does not exists! Бренда с таким кодом не существует
13 fail Brand with this name does not exists! Бренда с таким именем не существует
14 fail Brand is not available for update! Бренд для обновления не найден

Также могут возникать ошибки:

502 Bad Gateway - Если возникла данная ошибка необходимо:
1. Проверить, имеется ли доступ к Интернету (зайти на любой другой сайт).
2. Если проблем с доступом нет — можно удалить файлы cookies.
Если указанное выше не помогло — проблема на стороне сервера. Следует обратиться к системному администратору сайта.

503 (Service Temporarily Unavailable) - данная ошибка может возникать в результате слишком большого количества запросов к серверу. Если вы увидели такую ошибку, стоит подождать пару минут и попробовать снова.

504 Gateway Timeout - cкорее всего дело в возросшей нагрузке на сайт, при которой Apache не успевает отдавать HTTP-ответы, и новые запросы встают в очередь. Чтобы решить проблему, можно добавить ресурсов серверу, в частности оперативной памяти, и увеличить количество процессов httpd (Apache).
Другая возможная причина возникновения ошибки 504 - исполняемый скрипт не укладывается в отведенный лимит времени. Это бывает, когда запрос слишком тяжелый. Попробуйте разбить свой запрос на несколько более маленьких.

Ошибка 505 HTTP Version not supported означает, что веб-сайт не поддерживает версию протокола HTTP, с помощью которого браузер осуществляет запрос веб-страницы