API платформы

From Zapscript
Jump to: navigation, search
Other languages:
English • ‎русский

Данный модуль позволяет связать сторонние программные продукты с вашим сайтом.

Основные настройки

Безопасность подключения к платформе, осуществляется с помощью ключа.
Для пользователя вы можете включить и отключить данную функцию в разделе администрирования сайтом =>Клиенты=>Выбираем нужного клиента
В разделе включить доступ к API - ставим галочку, генерируется ключь.
Данный ключь и адрес сайта - домен, необходимо передать клиенту для подключения.

Переменные для программиста

Переменные:
<domain>-домен на которому размещен сайт
<search_phrase>-фраза поиска может включать , для разделения номеров артикулов, все артикулы приводятся к строке A-Za-z0-9 с разделением разных артикулов запятой
<id заказа>- ид заказа
Дата передается в формате 2005-08-15T15:52:01+00:00

Передача ключа доступа как Post параметр с именем “access_token” обязательное во всех запросах.

Поиск деталей, проценка

Запрос деталей
Запрос на адрес <domain>/api/orderApi/getProducts?search_phrase=<search_phrase>

Если запрос успешный то в результате получиться ответ с кодом 10 и выдаст позиции структура ниже, в иных случая выдаст код ошибки, роз шифровка ниже

Article- оригинальный номер удален весь шлак
article_order - оригинальный номер необходим для заказа
price- цена
brand- бренд
quantum- количество на складе
delivery- срок доставки дней (возможные значение число, текст , в наличие если срок 0)
name-наименование
store-склад на котором находиться запчасть



Array
(
[status] => 10
[products_count] => 3
[products] => Array
(
[0] => Array
(
[price] => 153.56
[brand] => Hyundai/Kia
[quantum] => 9
[delivery] => 0
[article] => 123
[article_order] => 123
[name] => ГАЙКА М8
[store] => KIA Motors RUS
)

[1] => Array
(
[price] => 200.75
[brand] => Hyundai/Kia
[quantum] => 17
[delivery] => 3
[article] => 123
[article_order] => 123
[name] => ГАЙКА
[store] => KIA Motors RUS
)

[2] => Array
(
[price] => 150.48
[brand] => Hyundai/Kia
[quantum] => 8
[delivery] => 2
[article] => 123
[article_order] => 123
[name] => ГАЙКА M8
[store] => KIA Motors RUS
)


)

[products_other_count] => 3
[products_other] => Array
(
[0] => Array
(
[price] => 1177.66
[brand] => Hyundai/Kia
[quantum] => 225
[delivery] => 1
[article] => 1987948849
[article_order] => 1987948849
[name] => УПЛОТНИТЕЛЬНОЕ КОЛЬЦО СТУПИЦЫ КОЛЕСА
[store] => KIA Motors RUS
)

[1] => Array
(
[price] => 575.96
[brand] => Hyundai/Kia
[quantum] => 128
[delivery] => 13
[article] => 1987948849
[article_order] => 1987948849
[name] => ГАЙКА M6
[store] => KIA Motors RUS
)

[2] => Array
(
[price] => 204.82
[brand] => Hyundai/Kia
[quantum] => 222
[delivery] => 0
[article] => 1987948849
[article_order] => 1987948849
[name] => БОЛТ М16
[store] => KIA Motors RUS
)

)

)

Отправка заказа на сайт

Оформление заказа<br>
Запрос на адрес <domain>/api/orderApi/ makeOrder
Дополнительные Post параметры make_order в виде массива где каждый елемент это позиция заказа состоит из массива атрибутов позиции
• article_order-оригинальный номер для заказа из поиска
• brand-бренд из поиска
• delivery-срок доставки из поиска
• store-наименование склада из поиска
• quantum- количество в заказ
в случае успешного оформления выведет созданы заказ
структура как в запросе информации о заказе

Получение данных заказов

Получение данных заказов Запрос на адрес <domain>/api/orderApi/getOrdersInfo

Ответ Json Структура delivery_cost-стоимость доставки total_cost-стоимость заказа без доставки

Array
(
[status] => 400
[orders_count] => 3
[orders] => Array
(
[0] => Array
(
[order_id] => 1
[delivery_cost] => 0
[total_cost] => 50515.8
[status] => Выполнен
[payed_status] => Оплачено
[delivery_zipcode] =>
[delivery_country] =>
[delivery_city] =>
[delivery_street] =>
[delivery_house] =>
[create_date] => 2014-09-28T23:00:00+03:00
[items] => Array
(
[0] => Array
(
[price] => 1370.08
[brand] => TRW
[quantum] => 1
[delivery] => 2(4) дня
[article] => JRA137
[name] => Тяга рулевая в сборе
[store] => RMS
[status] => Выполнен
[payed_status] => Не оплачен
[create_date] => 2014-09-29T22:19:28+03:00
)

[1] => Array
(
[price] => 1083.24
[brand] => DELPHI
[quantum] => 1
[delivery] => 2(4) дня
[article] => LP1458
[name] => Колодки тормозные
[store] => RMS
[status] => Отказ
[payed_status] => Не оплачен
[create_date] => 2014-09-29T22:19:28+03:00
)

)

)

[1] => Array
(
[order_id] => 2
[delivery_cost] => 0
[total_cost] => 955.72
[status] => Выполнен
[payed_status] => Оплачено
[delivery_zipcode] =>
[delivery_country] =>
[delivery_city] =>
[delivery_street] =>
[delivery_house] =>
[create_date] => 2014-09-29T23:00:00+03:00
[items] => Array
(
[0] => Array
(
[price] => 955.72
[brand] => Hyundai/Kia
[quantum] => 1
[delivery] => 2(4) дня
[article] => 986204Y000
[name] => БАЧОК ЖИДКОСТИ СТЕКЛООМЫВАТЕЛЯ
[store] => KIA Motors RUS
[status] => Выполнен
[payed_status] => Не оплачен
[create_date] => 2014-09-30T11:03:46+03:00
)

)

)

[2] => Array
(
[order_id] => 3
[delivery_cost] => 0
[total_cost] => 82376.6
[status] => Выполнен
[payed_status] => Оплачено
[delivery_zipcode] =>
[delivery_country] =>
[delivery_city] => Москва
[delivery_street] => 2-й Силикатный проезд
[delivery_house] => 34/1
[create_date] => 2014-09-29T23:00:00+03:00
[items] => Array
(
[0] => Array
(
[price] => 76.31
[brand] => PEUGEOT/CITROEN
[quantum] => 10
[delivery] => 2(4) дня
[article] => 693686
[name] => Гайка стойки стабилизатора
[store] => RMS
[status] => Отказ
[payed_status] => Не оплачен
[create_date] => 2014-09-30T11:33:29+03:00
)

[1] => Array
(
[price] => 52.96
[brand] => Citroen/Peugeot
[quantum] => 15
[delivery] => в наличии
[article] => 693686
[name] => Гайка
[store] => KSP service
[status] => Выполнен
[payed_status] => Не оплачен
[create_date] => 2014-09-30T11:33:29+03:00
)

Получение информации о конкретном заказе

Получение информации о конкретном заказе
Запрос на адрес <domain>/api/orderApi/getOrdersInfo? order_id=<id заказа>
вывод аналогичен как во всех заказах только будет выведена информация о запрашиваем заказе

Отказ от заказа

Отказ от заказа
Запрос на адрес <domain>/api/orderApi/getOrdersInfo? order_id=<id заказа>
Если по заказу уже прошла оплата или частично прошла оплата, или статус выполнен то отмена заказа не возможна.
В случае успешного запроса Вывод аналогичен как во всех заказах только будет выведена информация о данyом заказе

Статусы

a. 10 – Поиск прошел успешно, результат позиции
b. 0-Не правильный запрос
c. 100 – Доступ запрещен (неправильный ключ подключения)
d. 105-- Доступ запрещен (Ключ правильный, но до доступ временно закрыт)
e. 300-Заказ не найден
f. 400 – Заказ/заказы успешно найдены и выведены
g. 200-Заказ принят
h. 220-Заказ отменен
i. 225 – отмена заказа не возможна