Открыть главное меню

API:CrossBase: различия между версиями

м
 
(не показаны 2 промежуточные версии этого же участника)
Строка 3: Строка 3:
 
'''Содержание'''
 
'''Содержание'''
 
* [[#search_tips|Подсказка при наборе номера]]
 
* [[#search_tips|Подсказка при наборе номера]]
 +
* [[#articles_info|Получение карточки товара]]
  
 
=База знаний ABCP =
 
=База знаний ABCP =
Строка 10: Строка 11:
 
=Описание операций API=
 
=Описание операций API=
  
==Поиск запчастей==
+
=Поиск запчастей=
  
 
+
<span id="search_tips"></span>
===Подсказка при наборе номера===
+
==Подсказка при наборе номера==
  
 
'''Операция:''' search/tips
 
'''Операция:''' search/tips
Строка 57: Строка 58:
 
|}
 
|}
  
{{Anchor|search_tips}}
+
<span id="articles_info"></span>
 +
==Получение карточки товара==
 +
'''Операция:''' articles/info
 +
 
 +
'''Метод:''' GET{{Информация|Данная операция доступна только API-администратору}}Возвращает данные по указанному в параметрах товару
 +
 
 +
'''Параметры запроса'''
 +
{| class="wikitable"
 +
!Параметр
 +
!Описание
 +
|-
 +
!userlogin
 +
|Имя пользователя
 +
|-
 +
!userpsw
 +
|md5-хэш пароля пользователя
 +
|-
 +
!brand
 +
|Имя производителя
 +
|-
 +
!number
 +
|Код детали
 +
|-
 +
!format
 +
|Формат ответа. Допустимые значения: [b][n][p][c][h][m][t][i] - формат вывода информации (b - бренд, n - номер, p - свойства, c - кроссы, h - свойства с учетом локали, m - информация о модели, t - вывод типа кроссов с учетом направления, i - изображения запчасти).
 +
|-
 +
!cross_image
 +
|При передаче cross_image=1 и [i] в параметре format в ответе операции будут выводиться изображения кроссов.
 +
|-
 +
!source
 +
|Источник кроссов. Необязательный параметр. Через него передается массив со списком источников, в которых нужно искать кроссы. 
 +
standard - Кроссы с достоверностью 99.9 % ;
 +
common- Кроссы с достоверностью 95%;
 +
common_cat - Кроссы нескольких неоригинальных каталогов.
 +
Если параметр не передается, то в ответе выводятся все источники, подключенные в ПУ
 +
пример: &source[]=standard&source[]=common
 +
|-
 +
!with_original
 +
|Признак кроссирования через оригинал. Необязательный параметр. Через него передается массив со списком источников, в которых используется кроссирование через оригинал. Работает данный параметр только при ручном указании источников кроссов (source). Если его не передавать то в ответе нет кроссов через оригинал по указанным источникам.
 +
Если указать данный параметр без указания конкретных источников - в ответе получаем текст "Для получения аналогов через оригинал обязательно указывайте источники кроссов".
 +
 
 +
пример: &with_original[]=standard&with_original[]=common
 +
|-
 +
!locale
 +
|Локаль. Задается в формате language[_territory], например, ru_RU. Это же значение используется по умолчанию.
 +
|}
 +
 
 +
'''Пример запроса'''
 +
https://demo.public.api.abcp.ru/articles/info?userlogin=username&userpsw=md5pass&brand=Febi&number=01089&format=bnpic
 +
Метод возвращает массив объектов вида:
 +
{| class="wikitable"
 +
!Параметр
 +
!Описание
 +
|-
 +
!brand
 +
|Имя производителя
 +
|-
 +
!number
 +
|Искомый номер детали
 +
|-
 +
!outer_number
 +
|Номер детали, содержащий пробелы, слэши и другие символы.
 +
|-
 +
!short_number
 +
|Сокращённый номер детали. Нужен для идентификации в вашей поисковой выдаче одинаковых артикулов. Например, в случае двойной маркировки свечей NGK.
 +
|-
 +
!alt_number
 +
|Альтернативный номер детали. Нужен для идентификации в вашей поисковой выдаче одинаковых артикулов. Например, в случае коротких и полных номеров по бренду Mercedes (с буквой A и без)
 +
|-
 +
!properties
 +
|Массив свойств детали: описание, вес, объем и т.п. (при включенном формате p)
 +
|-
 +
!crosses
 +
|Массив информации об аналогах (при включенном формате c).
 +
Пример: А - запрашиваемая деталь
 +
crossType = 1 - замена (replacement), деталь B заменяет деталь A
 +
crossType = 2 - входит в комплект (unclude), деталь B является частью детали A
 +
crossType = 3 - является частью комплекта (part of), деталь A является частью детали B
 +
crossType = 4 - односторонняя замена, деталь A заменяется на деталь B
 +
crossType = 5 - односторонняя замена, деталь A является заменой для детали B
 +
|-
 +
!images
 +
|Массив изображений товара (при включенном формате i). В массиве указаны имена файлов расположенных по адресу https://pubimg.4mycar.ru/images/
 +
|}<!--|-
 +
!directorFullName
 +
|ФИО директора-->

Текущая версия на 15:50, 13 августа 2025


Содержание

База знаний ABCP

Тут общая инфа о базе и тарифах

Описание операций API

Поиск запчастей

Подсказка при наборе номера

Операция: search/tips

Метод: GET

Возвращает по части номера массив подходящих пар бренд - номер

Параметры запроса

Параметр Описание
userlogin Имя пользователя в системе
userpsw md5-хэш пароля пользователя в системе
number Номер (часть номера) детали
locale Локаль. Задается в формате language[_territory], например, ru_RU. По умолчанию используется локаль сайта.

Пример запроса

https://demo.public.api.abcp.ru/search/tips?userlogin=username&userpsw=md5pass&number=0108

Поля ответа

Метод возвращает массив объектов вида:

Поле Описание
brand Имя производителя.
number Номер детали (код производителя).
description Описание запчасти

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

Операция: articles/info

Метод: GET

vertical-align:middle;
Информация
Данная операция доступна только API-администратору

Возвращает данные по указанному в параметрах товару

Параметры запроса

Параметр Описание
userlogin Имя пользователя
userpsw md5-хэш пароля пользователя
brand Имя производителя
number Код детали
format Формат ответа. Допустимые значения: [b][n][p][c][h][m][t][i] - формат вывода информации (b - бренд, n - номер, p - свойства, c - кроссы, h - свойства с учетом локали, m - информация о модели, t - вывод типа кроссов с учетом направления, i - изображения запчасти).
cross_image При передаче cross_image=1 и [i] в параметре format в ответе операции будут выводиться изображения кроссов.
source Источник кроссов. Необязательный параметр. Через него передается массив со списком источников, в которых нужно искать кроссы.

standard - Кроссы с достоверностью 99.9 % ; common- Кроссы с достоверностью 95%; common_cat - Кроссы нескольких неоригинальных каталогов. Если параметр не передается, то в ответе выводятся все источники, подключенные в ПУ пример: &source[]=standard&source[]=common

with_original Признак кроссирования через оригинал. Необязательный параметр. Через него передается массив со списком источников, в которых используется кроссирование через оригинал. Работает данный параметр только при ручном указании источников кроссов (source). Если его не передавать то в ответе нет кроссов через оригинал по указанным источникам.

Если указать данный параметр без указания конкретных источников - в ответе получаем текст "Для получения аналогов через оригинал обязательно указывайте источники кроссов".

пример: &with_original[]=standard&with_original[]=common

locale Локаль. Задается в формате language[_territory], например, ru_RU. Это же значение используется по умолчанию.

Пример запроса

https://demo.public.api.abcp.ru/articles/info?userlogin=username&userpsw=md5pass&brand=Febi&number=01089&format=bnpic

Метод возвращает массив объектов вида:

Параметр Описание
brand Имя производителя
number Искомый номер детали
outer_number Номер детали, содержащий пробелы, слэши и другие символы.
short_number Сокращённый номер детали. Нужен для идентификации в вашей поисковой выдаче одинаковых артикулов. Например, в случае двойной маркировки свечей NGK.
alt_number Альтернативный номер детали. Нужен для идентификации в вашей поисковой выдаче одинаковых артикулов. Например, в случае коротких и полных номеров по бренду Mercedes (с буквой A и без)
properties Массив свойств детали: описание, вес, объем и т.п. (при включенном формате p)
crosses Массив информации об аналогах (при включенном формате c).

Пример: А - запрашиваемая деталь crossType = 1 - замена (replacement), деталь B заменяет деталь A crossType = 2 - входит в комплект (unclude), деталь B является частью детали A crossType = 3 - является частью комплекта (part of), деталь A является частью детали B crossType = 4 - односторонняя замена, деталь A заменяется на деталь B crossType = 5 - односторонняя замена, деталь A является заменой для детали B

images Массив изображений товара (при включенном формате i). В массиве указаны имена файлов расположенных по адресу https://pubimg.4mycar.ru/images/