Опис API

Описання

Для роботи з API використовується Токен, який можна отримати додаючи нового користувача типу API у меню Компанія/Користувачі.

Створити API

Загальний формат url для всіх https-запитів:

https://lex.trade/api/{versionAPI}/{method}/{id}

POST-параметри [query1=val1,query2=val2,...]

Параметри для всіх https-запитів:

Параметр	Описання
versionAPI	Версія API
method	Назва методу API, наприклад, catalog
id	Id запису для запитів, що повертають один результат
query1, val1	Додаткові параметри, які уточнюють запит та/або дані для POST-запитів.

Відповідь приходить у форматі JSON і містить об'єкти верхнього рівня success, results/result або errors. Помилка об'єкта уточнюється параметром message.

Для авторизації по токену слід використовувати тип авторизації Bearer token.

Приклад запиту отримання довідника товарів:

<?php header('Content-Type: text/html; charset=utf-8'); // URL REST API const API_URL = 'https://lex.trade/api/v1/'; // Токен авторизації (замініть на свій токен) const API_TOKEN = 'ВАШ_ТОКЕН'; // Надсилання запиту GET function makeGetRequest( $route, $params = [], $echo = false ){ $url = API_URL . $route; // Створюємо заголовки для авторизації $header = [ 'Authorization: Bearer ' . API_TOKEN, 'Content-Type: application/json', ]; // Ініціалізуємо cURL-сесію $curl = curl_init(); // Встановлюємо параметри cURL-сесії curl_setopt_array($curl, array( CURLOPT_URL => $url, CURLOPT_RETURNTRANSFER => true, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_POSTFIELDS => json_encode($params),// CURLOPT_HTTPHEADER => $header, )); // Виконуємо GET-запит до REST API $response = curl_exec( $curl ); // Перевіряємо наявність помилок під час виконання запиту if ($response === false) { die('Помилка cURL: ' . curl_error($curl)); } // Закриваємо cURL-сесію curl_close($curl); // Виводимо відповідь від REST API if ( $echo ) { return $response; } else { return json_decode($response); } } // Довідник номенклатури $url = 'catalog'; $result_json = makeGetRequest($url, [], true); echo $result_json;

Приклад відповіді:

{ "results":[ { "id":"99d3009f-5ac7-4b31-ba74-ebc79b53e3e2", "categoryId":"998c7f29-76a0-4fe1-8892-a96322decc20", "name":"Кросівки Adidas Strutter GX0672 40 (6.5UK) 25 см Wonmau\/Ftwwht\/Dshgry (4065418995207)", "code":"4","price":1779, "currencyAlpha":"UAH", "unitName":"шт.", "pictures":[ "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133.jpg", "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133-01.jpg", "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133-02.jpg", "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133-03.jpg", "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133-04.jpg", "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133-05.jpg", "https:\/\/lex.trade\/online\/acc\/1064\/photo\/62133-06.jpg" ], "typeName":"Товар", "options":{ "0":{ "name":"Виробник", "value":"Adidas - Індонезія" }, "1":{ "name":"Артикул", "value":"4065418995207" }, "2":{ "name":"Вид", "value":"Кросівки" }, "3":{ "name":"Розмір", "value":"40" }, "4":{ "name":"Призначення", "value":"Для повсякденного носіння" }, "5":{ "name":"Сезон", "value":"Весняний, Літній, Осінній" }, "6":{ "name":"Колір", "value":"Рожевий" }, "7":{ "name":"Матеріал верху", "value":"Натуральна шкіра" }, "8":{ "name":"Матеріал підкладки", "value":"Текстиль" }, "9":{ "name":"Матеріал підошви", "value":"Гума" }, "10":{ "name":"Гарантія, міс.", "value":"" } }, "shortDescription": "", "description": "", "comment":"" }, ... ], "success":true }

Приклад помилки:

{ "success":false, "errors":[ { "message":"Неуспішна авторизація." } ] }