Search

API для синхронизации товаров

Получение Token

Для того чтобы получить token необходимо перейти по ссылке ниже (заменив поле {yourdomain} на название своего аккаунта) и в открывшемся окне нажать кнопку «Получить токен».

https://{yourdomain}.laim.bz/settings/getToken.

Запросы

В запросе обязательно необходимо передать header:

X-Access-Token:token

Если в запросе есть body, то в header указать:

Content-Type : application/json

Строка запроса:

https://api.laim.bz/1.0/название сущности/метод?параметр1=значениеПараметра1&параметр2=значениеПараметра2

Ответ

Если запрос прошел успешно, то вернется http код = 200 и объект.

Успешный ответ:

ТипЭлемент объектаЗначение
booleansuccesstrue
objectdataобъект или массив объектов

data содержит либо сам объект с передаваемой сущность (для методов get), либо

ТипЭлемент объектаЗначение
arrayitemsмассив объектов
booleanhasMoretrue — в БД есть еще значение

Пример:

{
   "success": true,
   "data": {
         "items": [],
         "hasMore": false
           }
}

Неуспешный ответ:

ТипЭлемент Значение
booleansuccessfalse
object errorобъект с описанием ошибки

Объект error:

ТипНазваниеЗначение
integercodeкод ошибки (возможные ошибки написаны к каждому методу отдельно)
stringmessageтекст ошибки

Пример:

{
   "success": false,
      "error":
      {
         "code": 100,
         "message": "Не найден Section с таким id"
       }
}

Стандартные ошибки

Http кодОписание ошибки
401Неверный token.
500Неизвестная ошибка сервера.