Ларди Транс API

Условия использования Lardi-Trans API и ограничение ответственности

Lardi-Trans API (далее Lardi-Trans АРІ или АРІ) предоставляется на условиях «как есть» (as is).
Разработчики АРІ четко и однозначно уведомляют любого пользователя о том, что они не предоставляют гарантии того, что Lardi-Trans API будет соответствовать Вашим требованиям, а также что в процессе работы АРІ не будут возникать прерывания или ошибки, а также не гарантируют работоспособность ни АРІ в целом, ни отдельных функций АРІ ни на данный момент, ни в будущем.
Lardi-Trans АРІ находится в активной разработке, поэтому разработчики АРІ четко и однозначно уведомляют любого пользователя АРІ о том, что изменения кода, алгоритмов, методов, форматов ответов и любых других функций и элементов Lardi-Trans АРІ производится постоянно и без предварительного согласования с пользователями, а также без уведомления пользователя о внесенных изменениях.
Вы несете ответственность за любое использование Lardi-Trans АРІ, которое позволит Вам достичь намеченных результатов, а также ответственность за результаты, которые будут достигнуты благодаря использованию Lardi-Trans АРІ. Исключительно пользователи АРІ несут все риски, связанные с качеством, производительностью и работоспособностью Lardi-Trans АРІ.
Ни в каких случаях разработчики АРІ не несут ответственности перед пользователями Lardi-Trans АРІ или любыми третьими лицами за любые сопутствующие, случайные, косвенные, фактические, типовые или штрафные убытки или упущенную выгоду, даже если разработчики были предварительно осведомлены о возможности таких убытков.
Использование Lardi-Trans API подразумевает полное согласие пользователя с указанными правилами использования Lardi-Trans API и ограничением ответственности.

Техническая информация

Lardi-Trans API это RESTful сервис для разработчиков, с помощью которого можно программно взаимодействовать с продуктами Lardi-Trans.
Lardi-Trans API построен по принципам REST, все данные, которыми обмениваются клиент и API, это JSON по HTTPS протоколу.
Базовый адрес для Lardi-Trans API это https://api.lardi-trans.com/v2

Авторизация

Все запросы на API должны содержать HTTP header с вашим уникальным ключом (токеном). Например:

Authorization: 2UL4BXx01wU000000025

Вместо токена2UL4BXx01wU000000025 вам нужно подставить ваш собственный. Работа со своими токенами доступна на сайте в разделе Настройки - API.

Язык

Для получения результата на желаемом языке нужно указать его в параметре language, например - ?language=uk. По умолчанию это русский (ru). Допустимые значения — mnemo из справочника языков, с другим значением API ответит 400 Bad Request.

Ошибки

Lardi-Trans использует коды состояния HTTP для индикации результата запроса. Коды в диапазоне 2хх говорят об успешном запросе, в диапазоне 4хх указывают на ошибку запроса (отсутствует обязательный параметр запроса, запрошенный ресурс не существует и т.д.), а коды в диапазоне 5хх сигнализируют об ошибках самого сервиса.

Код	Статус	Описание
200	OK	Запрос отработал успешно
201	Created	Ресурс создан успешно
400	Bad Request	Неверный запрос (нет обязательного параметра, недопустимое значение параметра, тело не разобрать)
401	Unauthorized	Не указан уникальный ключ клиента или указанный ключ не найден
403	Forbidden	Доступ запрещен
404	Not Found	Ресурс не найден, неизвестный адрес или параметр пути или запроса не того типа (например, буквы вместо числа)
422	Unprocessable Entity	Запрос не может быть обработан по причине логической несовместимости переданных данных
429	Too Many Requests	Клиент отправляет слишком много запросов
50*	Server Errors	Произошла ошибка на стороне сервера

Тело ответа с ошибкой у всех методов и статусов одного вида:

Поле	Описание	Тип данных
statusCode	Код HTTP-статуса.	Число
message	Описание ошибки на языке запроса (параметр *language*); если перевода нет — как есть.	Строка
errorCode	Код ошибки, если он есть у метода (например, коды ошибок заявок), иначе `0`.	Число
wrongFields	Ошибки отдельных полей запроса — `fieldName`, `message`, `errorCode`; если таких нет — `null`.	Массив
messageArgs	Параметры сообщения, обычно `null`.	Объект

{
    "statusCode": 400,
    "message": "Required parameter 'ids' is not present.",
    "errorCode": 0,
    "wrongFields": null,
    "messageArgs": null
}

Тело в другом формате (или пустое) — у ответа на неизвестный адрес (404) и на тело запроса, в котором поле не того типа (400).