Ларді Транс 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).