Получение 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 и объект.
Успешный ответ:
Тип | Элемент объекта | Значение |
---|---|---|
boolean | success | true |
object | data | объект или массив объектов |
data содержит либо сам объект с передаваемой сущность (для методов get), либо
Тип | Элемент объекта | Значение |
---|---|---|
array | items | массив объектов |
boolean | hasMore | true — в БД есть еще значение |
Пример:
{
"success": true,
"data": {
"items": [],
"hasMore": false
}
}
Неуспешный ответ:
Тип | Элемент | Значение |
---|---|---|
boolean | success | false |
object | error | объект с описанием ошибки |
Объект error:
Тип | Название | Значение |
---|---|---|
integer | code | код ошибки (возможные ошибки написаны к каждому методу отдельно) |
string | message | текст ошибки |
Пример:
{
"success": false,
"error":
{
"code": 100,
"message": "Не найден Section с таким id"
}
}
Стандартные ошибки
Http код | Описание ошибки |
---|---|
401 | Неверный token. |
500 | Неизвестная ошибка сервера. |