REST API on База знаний DataMobile

Структура запросов

Mon, 01 Jan 0001 00:00:00 +0000

Параметры

POST | GET | PUT | DELETE


http|https://<api>/<resources>/<resource_id>/?<param1>=<value1>&<param2>=<value2> HTTP/1.1

Заголовки


 "headers": { 
 "Authorization": "Basic dHNkdXNlcjoxMjM=", // токен в base64 "Basic tsduser:123"
 }

Пример запроса


GET http://192.168.1.64:777/public/hs/DmPriceCheckerExch/api/articles/scan?device_id=CB7F84C5BC36D373596533286D228F03&barcode=12345678 HTTP/1.1
Authorization: Basic dHNkdXNlcjoxMjM=
Host: 192.168.1.64:777
Connection: Keep-Alive

Структура ответов

Mon, 01 Jan 0001 00:00:00 +0000

Параметры

Наименование	Описание	Значение
status_code	Код ответа	200 – успешный ответ 900 / 901 – исключение с сервера
Content-Type	Тип контента	application/json; charset=utf-8

Тело ответа

Тело ответа содержит информацию в формате JSON.
С описанием возможных полей и структурой тела вы можете познакомиться в разделах, посвященных запросам к API.

Пример ответа

Запрос:
GET http://192.168.1.64:777/public/hs/DmPriceCheckerExch/api/system/ping?device_id=CB7F84C5BC36D373596533286D228F03 HTTP/1.1

Ответ:


HTTP/1.1 200 OK
Date: Fri, 29 Nov 2024 08:49:28 GMT
Server: Apache/2.4.4 (Win32)
Content-Length: 19
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json; charset=utf-8

{"is_success":true}

Исключения

Mon, 01 Jan 0001 00:00:00 +0000

Коды ответов

Код	Описание
200	Успешный ответ
900	Исключение для вывода в диалог
901	Исключение для вывода в снекбар

Тело исключения

Content-Type: application/json; charset=utf-8

Наименование	Тип	Описание
title	string	Заголовок
description обязательное	string	Описание исключения

Пример

Запрос: GET http://192.168.1.64:777/public/hs/DmPriceCheckerExch/api/articles/scan?device_id=CB7F84C5BC36D373596533286D228F03&barcode=12345678 HTTP/1.1

Ответ:


HTTP/1.1 901 error
Date: Fri, 29 Nov 2024 08:20:43 GMT
Server: Apache/2.4.4 (Win32)
Content-Length: 84
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json; charset=utf-8

{"description":"Не удалось найти товар по штрихкоду!"}