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

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

Авторизация

Во всех запросах передавать заголовок вида:

Api-Key: Ключ доступа

---

Добавить клиента

POST: https://ibotby.ru/api/addclient

Параметры:

name — Полное имя, обязательно;
phone — Номер телефона;
idtg — TelegramId, обязательно;
status – Статус клиента;
source – Источник;
note – Примечание;

Ответ:

{
"result": "результат добавления",
"error": "описание ошибки, если не добавлено"
}

---

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

POST: https://ibotby.ru/api/getclients

Параметры (необязательно):

id — id клиентов через запятую;
idtg — TelegramId через запятую;
phone — Номера телефонов через запятую;
size — Количество элементов в ответе, по умолчанию 100;
page — Страница ответа, по умолчанию 0.

Ответ:

[{
"id": "id клиента",
"idtg": "TelegramId",
"date": "дата/время последней активности в формате unix timestamp",
"name": "полное имя клиента",
"username": "username в Telegram",
"phone": "номер телефона",
"source": "источник",
"status": "статус клиента",
"note": "примечание",
"bonus": "бонусные баллы",
"active": "1 — активен, 0 — не активен, -1 — заблокирован"
}]

---

Получить список заказов

POST: https://ibotby.ru/api/getorders

Параметры (необязательно):

id — Номера заказов через запятую;
id_min — Минимальный номер заказа для выборки;
id_max — Максимальный номер заказа для выборки;
date_min – Первая дата/время периода выборки, в формате строки или unix timestamp;
date_max – Вторая дата/время периода выборки, в формате строки или unix timestamp;
status — Статус заказа для выборки, число (-1: отменен, 1: проверка, 2: принят, 3: оплачен, 4: выполнен);
idc — id клиентов через запятую;
size — Количество элементов в ответе, по умолчанию 100;
page — Страница ответа, по умолчанию 0.

Ответ:

[{
"id": "номер заказа",
"idc": "id клиента",
"date": "дата/время в формате unix timestamp",
"status": "статус заказа",
"user": "имя заказчика",
"phone": "номер телефона",
"items": [{ "name": "название товара", "art": "артикул", "price": "цена", "count": "количество" }],
"dlv": {"name": "способ доставки", "price": "цена доставки", "addr": "адрес доставки"},
"pay": {"name": "способ оплаты"},
"note": "примечание к заказу",
"bonus": "бонусные баллы",
"total": "итоговая сумма",
}]

---

Установить цену и остаток для товаров

POST: https://ibotby.ru/api/setoffers

Тело запроса:

[{
"name": "название товара",
"art": "артикул",
"barcode": "штрихкод",
"opt": "опциональный вариант",
"price": "новая цена",
"count": "остаток в наличии",
}]

Это массив с данными товаров для обновлениямя в формате JSON. В каждой строке из полей name, art, barcode — обязательно наличие одного любого для идентификации товара, opt — необязательно. Наличие поля price — если нужно обновить цену, count — если нужно обновить остаток.

Ответ:

{
"result": "сколько товаров обновлено",
}

---

Набор методов API может быть расширен по запросу.