1b.app
Скопирована ссылка -

API категорії (Category)

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

Параметры

Пример:

http://myboxurl/api/category/add/?login=LOGIN&password=PASSWORD&name=Категория&code=1333&hidden=0

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

Удаление категории, метод: /api/category/delete/

Параметры

Пример:

http://myboxurl/api/category/delete/?login=LOGIN&password=PASSWORD&id=666

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

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

Параметры

Пример:

http://myboxurl/api/category/update/?login=LOGIN&password=PASSWORD&code=1333&name=Категория&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 Описание категории Не обязательное поле.  
7 parentid string id родительской категории из вашей системы Не обязательное поле. В это поле вы можете вписать код родительской категории из вашей системы. Если категории с таким кодом не существует, поле примет пустое значение.
8 image array Массив изображений категории Не обязательное поле. Изображения следует передавать массивом с указанием полного пути к ним. Система работает с такими форматами изображений: jpg, png
9 hidden boolean скрытая категория Не обязательное поле. По умолчанию, категория не является скрытой (hidden=0)
10 parentcode string code1c категори (id категории из вашей системы) Не обязательное поле. В это поле вы можете вписать код родительской категории из вашей системы. Если категории с таким кодом не существует, поле примет пустое значение.

Получение одной категории и получение всех категорий метод: /api/category/get/

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

Пример:

http://myboxurl/api/category/get/?login=LOGIN&password=PASSWORD&id=666

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

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


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

Пример:

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

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

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

Подробнее
Статус Сообщение Описание сообщения
1 ok categoryid Возвращает id добавленной категории
2 fail Login is empty! Отсутствует логин
3 fail Password is empty! Отсутствует пароль
4 fail Category name is empty! Отсутствует название категории
5 fail Bad user level! Низкий уровень пользователя, для выполнения данного действия(нужен level 2 и выше)
6 fail Login or password not correct! Логин или пароль введены неверно
7 fail Category with this ID already exists! Категория с таким id уже существует
8 fail Incorrect picture! Некорректный формат изображения
9 fail You don't available category for delete! Вы не выбрали категорию для удаления
10 fail Category with this ID does not exists! Категории с таким ID не существует
11 fail Category with this Code does not exists! Категории с таким кодом не существует
12 fail You don't available category for update! Вы не выбрали категорию для обновления
13 fail parentid = categoryid id родительской категории равен id самой категории
или id родителя родительской категории равен id добавляемой категории (зацикленность)
14 fail Parentid is not corectly! id родительской категории не корректен

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

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, с помощью которого браузер осуществляет запрос веб-страницы