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, за допомогою якого браузер здійснює запит веб-сторінки