Работа с нашим API

Общее описание API

Для начала работы с API нужно скачать класс LinemediaAutoApiDriver, получить для него настройки и запросить у нас доступ для ip адреса вашего сервера.

Для подключения к серверу API используется класс LinemediaAutoApiDriver.

В нем настраиваем параметры подключения LINEMEDIA_AUTO_API_ID - ID в системе Linemedia Auto.

Теперь можно начать работу с API. Подключаем класс LinemediaAutoApiDriver и создаем его объект: $linemedia_auto_api = new LinemediaAutoApiDriver();

Метод query класса LinemediaAutoApiDriver с параметрами: название функции, аргументы функции, позволяет выполнять доступные функции api. API версии 0.1.0 поддерживает форматы передачи данных: serialized, json, xml.

Пример без параметров:

Пример с параметрами:

В данном примере мы вызываем функцию getBrands без параметров. В результате в переменной $result получаем массив данных:

Основные функции для формирования каталога:

Содержимое по меткам

Содержимое с указанными метками не найдено.

Получения брендов деталей.

Функция: 
getDetailBrands()

Result:

Получение производителей авто.

Функция: 
getBrands2()

Result:

Получения списка моделей данного производителя.

Функция:

getVehicleModels2()

Result:

Request parametrs:

Получение списка модификаций модели.

Функция:

getModelVariants2()

Result:

Request parametrs:

Получение групп деталей.

Функция:

getListOfGroups()

Result:

Request parametrs:

Получение списка деталей данной группы.

Функция:

getDetails2()

Result:

Request parametrs:

Получение информации о детали.

Функция:

getDetailInformation()

Request parametrs:

Получение картинки детали.

Функция:

getPictureUrlByDocId()

Result:

Request parametrs:

Поиск аналогов для запчастей

Получение аналогов по артикулу.

Функция:

getAnalogs2Multiple()

Result:

Request parametrs:

Примечание: запрос на поиск аналогов делается одним артикулом, если для данного артикула возвращаются каталоги, то второй запрос идет уже с двумя параметрами art и genericArticleId.

Эта функция вызывается с парамтром art, в котором передается артикул детали, функция возвращает аналоги к запрашиваемой детали, однако если в базе текдока есть несколько деталей с таким артикулом, то эта функция возвращает детали с запрашиваемым артикулом. Из этих деталей нужно выбрать одну и вызвать эту же функцию только уже с двумя параметрами: артикулом и genericArticleId - это идентификатор выбранной детали, и по этой паре параметров можно получить аналоги. Если деталь с таким артикулом одна в базе, то функция сразу возвращает аналоги. Аналоги включают в себя аналоги текдока, оригинальные номера запрашивоемой детали и аналоги из МонгоДБ. Монго ДБ - это наша база кроссов.

Вызов любой ф-ции из низкоуровнего API текдок http://webservicepilot.tecdoc.net/pegasus-2-0/doc/InterfaceCatService.PDF 
Метод toTecdoc
Параметры array('function'=>'TecdocFunctionName', 'parameter1'=>'...', 'parameter2'=>'...') 

Пример вызова ф-ции с параметрами LongList:
array(
'function'=>'getDirectArticlesByIds2', 
'articleId' => array('empty' => false , 'array' => array(222051)), 
'attributs' => true, 
'documents' => true, 
'documentsData'    => true, 
'immediateAttributs' => true, 
'immediateInfo'    => true, 
'info'   => false, 
'oeNumbers' => true, 
'priceDate' => null, 
'replacedByNumbers'  => true, 
'replacedNumbers'   => true, 
'usageNumbers'    => true, 
'prices'  => false, 
'eanNumbers'     => true, 
'mainArticles'    => true, 
'normalAustauschPrice'=> false
) 

Доступ к вебсервису проценки

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

Логин и пароль передаются в запросе к вебсервису с помощью стандартной http basic авторизации.

Формат запроса

Запрос и его параметры передаются методом GET по протоколу HTTP. Логин и пароль передаются с помощью стандартной http basic авторизации.

Возможные параметры запроса:

Пример запроса (login=client, password=clientclient):
GET /bitrix/admin/linemedia.auto_search.php?q=gdb1550 HTTP/1.1
Host: auto.x.linemedia.ru
Authorization: Basic Y2xpZW50OmNsaWVudGNsaWVudA==
Connection: close

Формат ответа

В случае успешной авторизации сервер формирует ответв  формате json. Возможно два варианта ответа: уточнение бренда и детали с проценкой.

Уточнение бренда(список каталогов).

В возвращаемом json-объекте присутствует поле catalogs. Его значение – массив, с ключами, равными названию бренда, а значение содержит массив со следующими данными:

Остальные поля являются служебными, их использование в настоящий момент настоятельно не рекомендуется.

Пример ответа:

{"catalogs":

    {

        "ATOY": {

                    "article":"6002",

                    "brand_title":"ATOY",

                    "title":"Пружина подвески задн.kadett c -79t",

                    "source":"mikadoparts_333",

                    "extra":

                            {"mikadopartsbt":"ATOY","wf_b":null},"sources":["mikadoparts_333"]

                }

    }

}

Проценка деталей

Ответ в формате json. По ключу parts записан массив типов деталей в ответе, ключи которого имеют вид ANALOG_TYPE_X, а значение – массив процененных деталей.

Значение X в ключах ANALOG_TYPE_X может принимать следующие значения:

Каждый элемент – массив со следующими значениями:

Пример ответа:

{"parts":{

        "analog_type_N":[

                            {

                            "id":"13033780",

                             "title":"gdb1550",

                             "article":"gdb-1550",

                            "brand_title":"TRW",

                            "price_src":3780,

                            "quantity":"40.00",

                            "delivery":0,

                            "modified":"2013-05-28 18:13:47",

                            "weight":0

                            }

                        ]

        }

}