Описание web-сервиса (Подключение API)
REST API сервиса euro-detal.ru работает по протоколу HTTPS и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.
Основной URL
Все ссылки на запросы к API в данной документации включают обязательный основной URL:
https://euro-detal.ru/api/get/
Авторизация
Код ключа (Api key) выдается администратором сайта при обращении.
Процесс авторизации возможен при наличии персонального ключа (Api key), которым в дальнейшем должен быть подписан каждый запрос к API.
Код ключа (Api key) передается GET параметром любого запроса.
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y
Ответ API
В ответ на каждый запрос к Api возвращается массив в формате JSON, который содержит status, data и errors.
- status имеет два значение:
- "ok" запрос прошел успешно
- "fail" возникала ошибка. В этом случае errors указывает на ошибку.
- data содержит результат запроса
Методы
getBrands - получить все бренды
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=getBrands
Пример ответа:
{ "status" : "ok", "data":{
"10558": {
"brand_id" : "10558",
"brand_name" : "Hella"
}
...
Где:
- brand_id - id бренда
- brand_name - наименование бренда
searchProduct - поиск товара. В ответе можем получить не только сам товар, но аналоги.
Обязательный GET-параметр sku - артикул товара
Не обязательный GET-параметр brand - наименование бренда товара
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=searchProduct&sku=50013465
Пример ответа:
{ "status" : "ok", "data":{
"2292": {
"product_id" : "2292",
"sku" : "50013465"
"display" : "50013465",
"name" : "Фильтр масляный МАН",
"brand_id" : "399",
"brand_name" : "KOLBENSCHMIDT",
"price" : "477",
"count" : "1",
"srok" : "В наличии",
"image" : "https://euro-detal.ru/wa-data/public/shop/products/84/94/849484/images/302015/302015.640x0.jpg",
}
...
Где:
- product_id - id товара
- sku - артикул без спец. символов
- display - артикул со спец. символами
- name - наименование товара
- brand_id - id бренда
- brand_name - наименование бренда
- price - цена продажи в РУБ.
- count - кол-во товара
- srok - срок поставки
- image - ссылка на изображение
addToCart - добавить товар в корзину
Обязательный GET-параметр product_id - id товара
Не обязательный GET-параметр quantity - кол-во товара. По умолчанию 1
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=method=addToCart&product_id=2292
Пример ответа:
{ "status" : "ok", "data":{
"item_id": 17000
...
Где:
- item_id - id позиции в корзине
getCartItems - получить все товары в корзине
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=getCartItems
Пример ответа:
{ "status" : "ok", "data":{
"17000": {
"item_id" : "17000",
"product_id" : "2292"
"name" : "Фильтр масляный МАН"
"brand_name" : "KOLBENSCHMIDT"
"quantity" : "1",
"sku" : "50013465",
"price" : "477"
}
...
Где:
- item_id - id позиции в корзине
- product_id - id товара
- quantity - кол-во товара
- sku - артикул без спец. символов
- price - цена продажи в РУБ.
setQuantity - изменить кол-во товара в корзине
Обязательный GET-параметр item_id - id позиции в корзине
Обязательный GET-параметр quantity - кол-во товара
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=setQuantity&item_id=17024&quantity=4
Пример ответа:
{ "status" : "ok", "data" : true }
removeItemFromCart - убрать товар в корзину
Обязательный GET-параметр item_id - id позиции в корзине
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=removeItemFromCart&item_id=17000
Пример ответа:
{ "status" : "ok", "data" : true }
clearCart - очистить корзину
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=clearCart
Пример ответа:
{ "status" : "ok", "data" : true }
createOrder - создать заказ из товаров в корзине
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=createOrder
Пример ответа:
{ "status" : "ok", "data":{
"order_id": 3466
...
Где:
- order_id - id заказа
getOrders - получить все заказы в обработке
Пример запроса:
https://euro-detal.ru/api/get/?api_key=9DvCYv7LO703f9Y&method=getOrders
Пример ответа:
{ "status" : "ok", "data":{
"3471": {
"id" : "3471",
"create_datetime" : "2020-02-11 11:05:51"
"state_id" : "processing",
"total" : "19245",
"items" : { items }
}
...
Где:
- id - id заказа
- create_datetime - дата создания заказа
- state_id - статус заказа: new - новый, processing - в обработке, completed - завершенные.
- total - итого сумма по заказу в руб.
- items - массив товаров в заказе