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

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

Статья Обсуждение
 
(не показано 7 промежуточных версий 3 участников)
Строка 1: Строка 1:
−
{{Внимание|Данная статья предназначена для технических специалистов, обладающих, как минимум, начальными знаниями о принципах работы протокола HTTP. Консультации по вопросам относящимся к стандартам HTTP осуществляться не будут.}}
+
{{Внимание|Данная статья предназначена для технических специалистов, обладающих, как минимум, начальными знаниями о принципах работы протокола HTTPS. Консультации по вопросам относящимся к стандартам HTTPS осуществляться не будут.}}
 
__TOC__
 
__TOC__
  
 +
<br />
 
==API VINQU==
 
==API VINQU==
 +
===Авторизация запросов===
 +
Значения параметров '''siteHash''' и '''accessHash''' вы можете взять в [https://site.vinqu.com/?page=connect настройках интеграции своей учетной записи].
  
 
===Поиск одного вин запроса===
 
===Поиск одного вин запроса===
Строка 49: Строка 52:
 
  |}
 
  |}
  
−
<span>Информация о госте</span>
+
Информация о госте
  
−
{| class="wikitable" style="margin-left:50px"
+
{| class="wikitable"
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 78: Строка 81:
 
<span>Информация о авто</span>
 
<span>Информация о авто</span>
  
−
{| class="wikitable" style="margin-left:50px"
+
{| class="wikitable"
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 120: Строка 123:
 
<span>Информация о part</span>
 
<span>Информация о part</span>
  
−
{| class="wikitable" style="margin-left:50px"
+
{| class="wikitable"
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 134: Строка 137:
 
  |}
 
  |}
  
−
<span>массив структур предложений, полученных от экспертов</span>
+
массив структур предложений, полученных от экспертов
−
 
+
{| class="wikitable"
−
{| class="wikitable" style="margin-left:100px"
 
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 202: Строка 204:
 
<span>массив структур с сообщениями</span>
 
<span>массив структур с сообщениями</span>
  
−
{| class="wikitable" style="margin-left:50px"
+
{| class="wikitable"
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 239: Строка 241:
 
  |}
 
  |}
  
−
<span id="search_articles"></span>
+
===Поиск новых сообщений во всех чатах клиента===
−
 
+
'''Операция:''' vinquery/chatList'''<br />Метод:''' GET
−
====Поиск новых сообщений во всех чатах клиента====
 
−
'''Операция: vinquery/chatList'''<br />
 
−
'''Метод: GET'''
 
  
 
Осуществляет поиск всех новых сообщений, максимум за последние 15 минут по всем чатам клиента.
 
Осуществляет поиск всех новых сообщений, максимум за последние 15 минут по всем чатам клиента.
 
В случае отсутствия сообщений вернётся ошибка со статусом 404 и текстом `messages not found`
 
В случае отсутствия сообщений вернётся ошибка со статусом 404 и текстом `messages not found`
−
 
  
 
'''Параметры запроса'''
 
'''Параметры запроса'''
Строка 317: Строка 315:
 
  |}
 
  |}
  
−
====Поиск списка вин запросов====
+
===Поиск списка вин запросов===
−
'''Операция: vinquery/list'''<br />
+
'''Операция:''' vinquery/list<br />'''Метод:''' GET
−
'''Метод: GET'''
 
  
 
Осуществляет поиск списка вин запросов по переданным параметрам.
 
Осуществляет поиск списка вин запросов по переданным параметрам.
−
 
  
 
'''Параметры запроса'''
 
'''Параметры запроса'''
Строка 347: Строка 343:
  
 
'''Поля ответа'''
 
'''Поля ответа'''
−
 
−
 
 
{| class="wikitable"
 
{| class="wikitable"
 
  !Поле
 
  !Поле
Строка 361: Строка 355:
  
 
===Добавить сообщение в чат===
 
===Добавить сообщение в чат===
−
'''Операция: vinquery/addComment'''<br />
+
'''Операция:''' vinquery/addComment<br />'''Метод:''' POST
−
'''Метод: POST'''
 
  
 
Осуществляет добавление нового сообщения в чат
 
Осуществляет добавление нового сообщения в чат
Строка 414: Строка 407:
  
 
===Создание запроса===
 
===Создание запроса===
−
'''Операция: vinquery/add'''<br />
+
'''Операция:''' vinquery/add
−
'''Метод: POST'''
+
 
 +
'''Метод:''' POST
  
 
Осуществляет создание нового вин запроса
 
Осуществляет создание нового вин запроса
Строка 432: Строка 426:
 
  !clientId
 
  !clientId
 
  |id клиента
 
  |id клиента
 +
|-
 +
!file
 +
|Прикрепленный файл изображения. В curl запросе file=@"/path_to_image/image.jpg". Формат изображения: jpg/png
 
  |-
 
  |-
 
  !carInfo
 
  !carInfo
Строка 437: Строка 434:
 
  |}
 
  |}
  
−
<span>Информация об автомобиле</span>
+
Информация об автомобиле
  
−
{| class="wikitable" style="margin-left:50px"
+
{| class="wikitable"
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 467: Строка 464:
 
  |год выпуска.
 
  |год выпуска.
 
  |}
 
  |}
−
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Строка 488: Строка 484:
 
<span>Информация о госте</span>
 
<span>Информация о госте</span>
  
−
{| class="wikitable" style="margin-left:50px"
+
{| class="wikitable"
 
  !Поле
 
  !Поле
 
  !Описание
 
  !Описание
Строка 530: Строка 526:
 
===Получение марок===
 
===Получение марок===
  
−
'''Операция: brands/get'''<br />
+
'''Операция:''' brands/get
−
'''Метод: GET'''
+
 
 +
'''Метод:''' GET
  
 
Осуществляет поиск марок, подключённых сайту.
 
Осуществляет поиск марок, подключённых сайту.
Строка 551: Строка 548:
  
 
'''Поля ответа'''
 
'''Поля ответа'''
 +
 
Получает массив структур следующего вида
 
Получает массив структур следующего вида
 
{| class="wikitable"
 
{| class="wikitable"
Строка 568: Строка 566:
 
===Выставить вин запрос на биржу===
 
===Выставить вин запрос на биржу===
  
−
'''Операция: vinquery/on'''<br />
+
'''Операция:''' vinquery/on
−
'''Метод: POST'''
+
 
 +
'''Метод:''' POST
  
 
Осуществляет выставление вин запроса на биржу.
 
Осуществляет выставление вин запроса на биржу.
Строка 595: Строка 594:
  
 
'''Поля ответа'''
 
'''Поля ответа'''
 +
 
Получает массив структур следующего вида
 
Получает массив структур следующего вида
 
{| class="wikitable"
 
{| class="wikitable"
Строка 606: Строка 606:
 
===Снять вин запрос с биржи===
 
===Снять вин запрос с биржи===
  
−
'''Операция: vinquery/off'''<br />
+
'''Операция:''' vinquery/off
−
'''Метод: POST'''
+
 
 +
'''Метод:''' POST
  
 
Осуществляет снятие вин запроса с биржи.
 
Осуществляет снятие вин запроса с биржи.

Текущая версия на 18:26, 28 мая 2025

vertical-align:middle;
Внимание!
Данная статья предназначена для технических специалистов, обладающих, как минимум, начальными знаниями о принципах работы протокола HTTPS. Консультации по вопросам относящимся к стандартам HTTPS осуществляться не будут.


API VINQU

Авторизация запросов

Значения параметров siteHash и accessHash вы можете взять в настройках интеграции своей учетной записи.

Поиск одного вин запроса

Операция: vinquery/info/:id
Метод: GET

id - Идентификатор запроса (Обязательный параметр)

Осуществляет поиск вин запроса по переданным параметрам.

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

Параметр Описание
siteHash хэш сайта, с которого был отправлен вин запрос (Обязательный).
accessHash хэш доступа к API (Обязательный).

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

https://publicapi.vinqu.com/vinquery/info/518346?siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&accessHash=12345

Поля ответа

Поле Описание
_id id запроса.
resellerId id реселлера.
siteId id сайта.
clientId id клиента.
guestInfo Информация о госте.

Информация о госте

Поле Описание
name имя.
phone номер телефона.
email почта.
Поле Описание
expertId id эксперта.
carInfo информация о авто.

Информация о авто

Поле Описание
brand бренд.
model модель.
modificationId id модификации.
modification модификация.
vin вин номер.
frame фрейм номер.
hp лошадиные силы.
year год выпуска.
extraParams дополнительные параметры.
Поле Описание
parts массив с информацией о запрашиваемых запчастях следующего вида.

Информация о part

Поле Описание
partId уникальный id.
query запрос пользователя для поиска.
offers массив структур предложений, полученных от экспертов в следующем виде.

массив структур предложений, полученных от экспертов

Поле Описание
offerId уникальный id.
brand бренд.
number номер запчасти.
descr описание.
quantity количество.
expertId id эксперта.
createdDateTime timestamp создания предложения.
updatedDateTime timestamp обновления предложения.
deletedDateTime timestamp удаления предложения.
deleted флаг удалено ли предложение.
Поле Описание
createdDateTime timestamp создания запроса.
updatedDateTime timestamp обновления запроса.
assignedDateTime timestamp назначения запроса на эксперта.
acceptedDateTime timestamp принятия запроса экспертом.
completedDateTime timestamp завершения запроса.
processingTime время в секундах на выполнение запроса.
clientComment комментарий клиента.
chat массив структур с сообщениями в следующем виде.

массив структур с сообщениями

Поле Описание
timestamp отметка времени.
userId глобальный id юзера в системе.
expertId id эксперта, обрабатывающего запрос.
roleState состояние запроса.
roleState_loc состояние запроса в локализации (по умолчанию ru_RU - русская).
comment текст сообщения.
Поле Описание
images массив строк с названием изображений.
status статус запроса.
state текущее состояние запроса.

Поиск новых сообщений во всех чатах клиента

Операция: vinquery/chatList
Метод: GET

Осуществляет поиск всех новых сообщений, максимум за последние 15 минут по всем чатам клиента. В случае отсутствия сообщений вернётся ошибка со статусом 404 и текстом `messages not found`

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

Параметр Описание
siteHash хэш сайта (Обязательный параметр)
accessHash хэш доступа к API (Обязательный).
timestamp отметка времени, начиная с которой показывать сообщения
locale локализация (про умолчанию ru_RU) возможные значения (ru_RU , en_US)

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

https://publicapi.vinqu.com/vinquery/chatList?siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&accessHash=123456&timestamp=1533642418

Поля ответа в случае успешно выполненного запроса

Поле Описание
chatList массив, у которого ключ - номер запроса, значение - массив структур chatItem.

структура chatItem

Поле Описание
timestamp отметка времени.
userId id клиента.
expertId id эксперта, обрабатывающего запрос.
roleState состояние запроса.
roleState_loc состояние запроса локализованное.
comment текст сообщения.

Поля ответа в случае ошибки

Поле Описание
Error текст ошибки.

Поиск списка вин запросов

Операция: vinquery/list
Метод: GET

Осуществляет поиск списка вин запросов по переданным параметрам.

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

Параметр Описание
siteHash хэш сайта (Обязательный параметр)
accessHash хэш доступа к API (Обязательный).
skip начало выборки, по умолчанию 0
limit сколько максимум выбрать. По умолчанию 30


Пример запроса https://publicapi.vinqu.com/vinquery/list?siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&accessHash=123456

Поля ответа

Поле Описание
vinquery Массив структур вин запроса (пример выше в vinquery/info).
total Количество найденных запросов.

Добавить сообщение в чат

Операция: vinquery/addComment
Метод: POST

Осуществляет добавление нового сообщения в чат

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

Параметр Описание
siteHash хэш сайта (Обязательный)
accessHash хэш доступа к API (Обязательный).
userId id клиента
id id запроса
comment Текст сообщения

Пример запроса https://publicapi.vinqu.com/vinquery/addComment

POST параметры 

userId=123&id=321&comment=Test query&siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&accessHash=123456

Поля ответа в случае успеха

Поле Описание
Status true или false

Поля ответа в случае ошибки

Поле Описание
Error Текст ошибки

Создание запроса

Операция: vinquery/add

Метод: POST

Осуществляет создание нового вин запроса

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

Параметр Описание
siteHash хэш сайта (Обязательный)
accessHash хэш доступа к API (Обязательный).
clientId id клиента
file Прикрепленный файл изображения. В curl запросе file=@"/path_to_image/image.jpg". Формат изображения: jpg/png
carInfo Информация об автомобиле. Ассоциативный массив следующего вида

Информация об автомобиле

Поле Описание
brand бренд.
model модель.
modificationId id модификации.
modification модификация.
vin вин номер.
frame фрейм номер.
hp лошадиные силы.
year год выпуска.
Параметр Описание
clientComment Комментарий клиента.
parts Массив запчастей из запроса клиента.
stockEnable флаг 1 или 0, отправлять ли запрос на биржу.
guestInfo Информация о госте.

Информация о госте

Поле Описание
name имя.
phone номер телефона.
email почта.

Пример запроса https://publicapi.vinqu.com/vinquery/add

POST параметры 

clientId=123&carInfo[brand]=Luxgen&carInfo[vin]=222AAA11111111111&parts[]=test&parts[]=test1&clientComment=Test query&siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&stockEnable=1&accessHash=123456

Поля ответа в случае успеха

Поле Описание
QueryId id запроса

Поля ответа в случае ошибки

Поле Описание
Error Текст ошибки

Получение марок

Операция: brands/get

Метод: GET

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

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

Параметр Описание
hash хэш сайта (Обязательный)
accessHash хэш доступа к API (Обязательный).

Пример запроса https://publicapi.vinqu.com/brands/get?hash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&accessHash=123456

Поля ответа

Получает массив структур следующего вида

Поле Описание
brand Бренд.
price Цена
enabled включен или нет on или off

Выставить вин запрос на биржу

Операция: vinquery/on

Метод: POST

Осуществляет выставление вин запроса на биржу.

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

Параметр Описание
id id запроса
siteHash хэш сайта (Обязательный)
accessHash хэш доступа к API (Обязательный).

Пример запроса https://publicapi.vinqu.com/vinquery/on

POST параметры 

id=999999999&siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea12&accessHash=123456

Поля ответа

Получает массив структур следующего вида

Поле Описание
status false.

Снять вин запрос с биржи

Операция: vinquery/off

Метод: POST

Осуществляет снятие вин запроса с биржи.

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

Параметр Описание
id id запроса
siteHash хэш сайта (Обязательный)
accessHash хэш доступа к API (Обязательный).

Пример запроса https://publicapi.vinqu.com/vinquery/off

POST параметры 

id=123&siteHash=fa9839689336b1fc63c0e86a7cbeb558ce51ea2a&accessHash=123456

Поля ответа Получает массив структур следующего вида

Поле Описание
status false.
Источник — https://www.abcp.ru/w/index.php?title=APIVINQU&oldid=17624