Доступ к публичному API осуществляется посредством HTTP-запросов и реализован с использованием принципов REST. Базовым URI для веб-службы является:

Обмен осуществляется в кодировке UTF-8.
Для отладки вы можете воспользоваться расширением Advanced REST Client для обозревателя Google Chrome.

Запрос

Запросы на получение и запись данных осуществляются с помощью HTTP-методов GET и POST соответственно. В структуре сервиса имеется понятие операции. Операция указывается в качестве пути в URL. Параметры передаются как строка запроса HTTP (GET) или данными POST. Большая часть операций исполняется от имени конкретного пользователя и требует идентификации с помощью параметров userlogin (имя пользователя в системе) и userpsw (md5-хэш пароля пользователя). Md5-хэш можно сгенерировать выполнением функции (большая часть языков программирования имеет данную функцию в своем арсенале), либо воспользоваться online-генератором (например, md5x). Каждая операция может иметь список дополнительных параметров, определяемых контекстом операции. Например, вызов операции "Поиск детали по номеру" может выглядеть следующим образом:

При использовании метода POST в HTTP-заголовке Content-Type необходимо передать медиа-тип данных запроса application/x-www-form-urlencoded и соответственно с данным типом сформировать тело HTTP-запроса.

В HTTP-заголовке Accept необходимо передать ожидаемый тип данных ответа. В настоящее время реализован только тип JSON, и, в любом случае, будет возвращен он. Тем не менее, при разработке клиента, необходимо учитывать указанную особенность и передавать заголовок Accept со значением application/json.

Ответ

В случае успешного исполнения операции, веб-служба вернет ответ с HTTP-кодом 200 и телом ответа в виде JSON. Формат ответа определяется каждой операцией. Пример результата успешного выполнения запроса:

{
 "brand": "MERCEDES-BENZ",
 "number": "A1130940048",
 "short_number": "1130940048",
 "outer_number": "A 113 094 00 48",
 "properties": {
  "Масса, кг": "0.248",
  "Описание": "Датчик потока воздуха"
 },
 "images": [
  {
   "name": "00296fd49ba2b385e441829fc0b2913ea6.jpeg",
   "order": 0
  }
 ],
 "is_skipped_image": false,
 "images_count": 1,
 "rating": 112,
 "rating_4mycar": 88,
 "crosses": [
  {
   "brand": "ASHUKI",
   "number": "116617A",
   "numberFix": "116617A"
  },
  {
   "brand": "BBT",
   "number": "AMS405",
   "numberFix": "AMS405"
  }
 ]
}

Любой ответ с HTTP-кодом 400 и более является ошибочным, в теле содержит код ошибки и, как правило, текстовое сообщение описывающее причины возникшей ошибки также в виде JSON. Пример сообщения об ошибке:

  { 
    "errorCode": 102,
    "errorMessage": "User Authentication Error"
  }

Для организации качественного поиска автозапчастей на Вашем ресурсе предлагается использовать четыре api-функции.

Рекомендуемый алгоритм поиска в вашем сервисе с участием встроенных api-функций

Обратите внимание на особенность формирования первого этапа поиска с использованием функции search/brands. Суть в том, что вы добавляете в первый этап поиска те товары, которые могут привести (напрямую или через кроссы) к товарам, которые вы можете продать. Разумеется, часть товаров потенциально может отсутствовать в вашем товарном предложении, поэтому клик по каким-нибудь строчкам может привести к пустому результату. И в случае малого покрытия спроса вашим ассортиментом - такие случаи могут привести к уходу покупателя. Чтобы этого избежать, вы можете "заглянуть в будущее" для каждого товара из первого этапа поиска заранее, чтобы узнать "будет ли там что-нибудь в наличии" и для строк без наличия - исключить их. С другой стороны, в этом случае вы потеряете возможность собирать неудовлетворённый спрос (если вы его собираете и используете) и создадите дополнительную нагрузку на вашу базу дополнительными запросами.