В настоящий момент методы API позволяют автоматизировать работу с аукционом каталога UniShop.by. Набор методов может быть расширен.
Авторизация
Для сайта необходимо активировать ключ доступа API. Для этого в панели управления, в секции “Сайты”, нужно открыть форму редактирования нужного сайта, отметить соответствующую галочку и сохранить ключ.
Далее во всех запросах передавать заголовок вида:
Api-Key: Ключ доступа
Получение списка категорий аукциона
POST: https://astraweb.by/api/getcategories
Параметры: нет.
Ответ:
[ {
"id": "идентификатор категории",
"name": "название категории",
"rate": "текущая ставка",
"position": "текущая позиция",
"toprate": "ставка для первого места",
} ]
Получение списка магазинов в категории аукциона
POST: https://astraweb.by/api/getshops
Параметры:
id – идентификатор категории
Ответ:
[ {
"name": "название магазина",
"rate": "ставка"
} ]
Установить ставку в категории аукциона
POST: https://astraweb.by/api/setrate
Параметры:
id – идентификатор категории
rate – ставка
Ответ:
{
"id": "идентификатор категории",
"rate": "ставка",
"position": "текущая позиция",
}
Получить список заказов
POST: https://astraweb.by/api/getorders
Параметры:
date1 – Первая дата периода, в формате строки или unix timestamp, необязательно.
date2 – Вторая дата периода, в формате строки или unix timestamp, необязательно.
status — Значение статуса, число (0: Новый, 1: В обработке, 2: Обработан, 3: Отменен), необязательно.
Ответ:
{
"id": "идентификатор заказа",
"num": "номер заказа",
"date": "дата и время в формате unix timestamp",
"type": "тип (order: заказ, call: звонок)",
"phone": "номер телефона",
"user": "имя пользователя",
"address": "адрес доставки",
"name": "наименование товара или страницы",
"note": "примечение к заказу",
"sum": "сумма заказа",
"status": "значение статуса",
}
Установить статус заказов
POST: https://astraweb.by/api/setorders
Параметры:
id – идентификатор заказа (число или массив чисел)
status– значение статуса, число.
Ответ:
{
"result": "количество заказов с успешно изменным статусом"
}