Веб-сервисы
Сервис использует REST метод взаимодействия.
Урл веб-сервиса: http://{урл-магазина}/api-v2/{имя метода} без www, пример для zizap.ru — http://zizap.ru/api-v2/brands/.
Если у сайта включен https то API доступно как по http так и по https протоколам.
Авторизация
Для работы с сервисом не нужно проходить отдельно процедуру авторизации, для идентификации пользователя в каждом запросе используется базовая HTTP аутентификация по электронной почте и паролю пользователя.
Ошибки
Структура ответа с ошибкой
{
error: "Доступ с незарегистрированного IP"
}
Поиск производителей по номеру запчасти
Метод GET, POST
URL /api-v2/brands/
Входные параметры
| Название | Тип | Пример | Описание |
|---|---|---|---|
article | string | CP03 | Номер искомой детали |
Возвращаемые данные
| Название | Тип | Пример | Описание |
|---|---|---|---|
Коллекция brands | array of objects | Коллекция, содержащая информацию о производителях |
Структура элемента коллекции Brands
| Название | Тип | Пример | Описание |
|---|---|---|---|
article | string | CP03 | Артикул запчасти |
maker | string | HKT | Производитель запчасти |
name | string | HKT | Название запчасти |
Если с таким номером всего один производитель запчасти, то вместе с коллекцией brands возвращаются также коллекция parts. Описание коллекци parts см. ниже.
Пример запроса списка производителей на PHP
// Данные пользователя
$username = "user@mail.ru";
$password = "123";
//Искомый артикул
$article = "cp-02";
$url = "http://zizap.ru/api-v2/brands/";
$postData = http_build_query(["article" => $article]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
$response = curl_exec($ch);
curl_close($ch);
$brands = json_decode($response);
print_r($brands);
Поиск запчастей (проценка) по номеру запчасти и производителю
Метод GET, POST
URL /api-v2/parts/
Входные параметры
| Название | Тип | Пример | Описание |
|---|---|---|---|
article | string | CP03 | Номер искомой детали |
maker | string | HKT | Производитель искомой детали |
Возвращаемые данные
| Название | Тип | Пример | Описание |
|---|---|---|---|
Массив parts содержащий коллекции original и analog | array of objects | Коллекция original содержит оригинальные запчасти. |
Структура элемента коллекции original и analog
| Название | Тип | Пример | Описание |
|---|---|---|---|
priceId | string | b1lpzGIgfECbMMRhffxRFd | Внутренний идентификатор прайса в магазине |
detailNum | string | CP03 | Номер детали |
| makerName | string | HKT | Имя производителя |
| detailName | string | Свечи накаливания | Имя/Описание детали |
| quantity | string | >10 | Доступное количество |
| minimum | integer | 1 | Минимальное количество для заказа |
| region | string | ОАЭ | Регион |
| delivery | string | 1 | Срок доставки |
| percentSupped | integer | 65 | Вероятность наличия запчастей с этого прайса в процентах |
| price | float | 352.11 | Цена в валюте магазина |
| applicability | string | something | Поле «Справка» |
Пример поиска запчастей на PHP
// Данные пользователя
$username = "user@mail.ru";
$password = "123";
//Искомый артикул и производитель
$article = "cp-03";
$maker = "HKT";
$url = "http://zizap.ru/api-v2/parts/";
$postData = http_build_query(["article" => $article, "maker" => $maker]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
$response = curl_exec($ch);
curl_close($ch);
$parts = json_decode($response);
print_r($parts);
Добавление в корзину
Метод POST
URL /api-v2/add-to-basket/
Входные параметры — массив part.
Структура массива part
| Название | Тип | Пример | Описание |
|---|---|---|---|
priceId | string | z30B0ta6fSg= | Внутренний идентификатор прайса в магазине из структуры original или analog |
quantity | integer | 2 | Необходимое кол-во |
Возвращаемые данные
В случае успешного добавления в ответ будет получено сообщение message{message: "Запчасть добавлена в корзину"}
Пример добавления в корзину на PHP
// Данные пользователя
$username = "user@mail.ru";
$password = "123";
// Запчасть
$part = ["priceId" => "z30B0ta6fSg=", "quantity" => 2,];
$url = "http://zizap.ru/api-v2/add-to-basket/";
$postData = http_build_query(["part" => $part]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response));