Штрихкоды - Документация API

Получить все

Конечная точка

GET https://qrdom.ru/api/barcodes/

Пример

curl --request GET \
--url 'https://qrdom.ru/api/barcodes/' \
--header 'Authorization: Bearer {api_key}' \

Параметры	Детали	Описание
page	Необязательно Целое число	Номер страницы, с которой вы хотите получить результаты. По умолчанию `1`.
results_per_page	Необязательно Целое число	Сколько результатов вы хотите на странице. Допустимые значения: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. По умолчанию `25`.

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

{ "data": [ { "id": 1, "type": "C32", "name": "Example name", "value": "123456", "barcode": "https://qrdom.ru/uploads/barcode/example.svg", "settings": { "foreground_color": "#000000", "width_scale": 2, "height": 50, }, "embedded_data": "123456", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://qrdom.ru/api/barcodes?&page=1", "last": "https://qrdom.ru/api/barcodes?&page=1", "next": null, "prev": null, "self": "https://qrdom.ru/api/barcodes?&page=1" } }

Получить один

Конечная точка

GET https://qrdom.ru/api/barcodes/{barcode_id}

Пример

curl --request GET \
--url 'https://qrdom.ru/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \

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

{ "data": { "id": 1, "type": "C32", "name": "Example name", "value": "123456", "barcode": "https://qrdom.ru/uploads/barcode/example.svg", "settings": { "foreground_color": "#000000", "width_scale": 2, "height": 50, }, "embedded_data": "123456", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Создать

Конечная точка

POST https://qrdom.ru/api/barcodes

Параметры	Детали	Описание
project_id	Необязательно Целое число	-
name	Обязательно Строка	-
type	Обязательно Строка	Допустимые значения: `C32`, `C39`, `C39+`, `C39E`, `C39E+`, `C93`, `S25`, `S25+`, `I25`, `I25+`, `ITF14`, `C128`, `C128A`, `C128B`, `C128C`, `EAN2`, `EAN5`, `EAN8`, `EAN13`, `UPCA`, `UPCE`, `MSI`, `MSI+`, `POSTNET`, `PLANET`, `TELEPENALPHA`, `TELEPENNUMERIC`, `RMS4CC`, `KIX`, `IMB`, `CODABAR`, `CODE11`, `PHARMA`, `PHARMA2T`
is_bulk	Необязательно логическое значение
value	Обязательно Строка	-
foreground_color	Необязательно Строка	-
width_scale	Необязательно Целое число	1-10
height	Необязательно Целое число	30-1000

Параметры	Детали	Описание

Пример

curl --request POST \
--url 'https://qrdom.ru/api/barcodes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

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

{ "data": { "id": 1 } }

Обновить

Конечная точка

POST https://qrdom.ru/api/barcodes/{barcode_id}

Параметры	Детали	Описание
project_id	Необязательно Строка	-
name	Необязательно Строка	-
type	Необязательно Строка	Допустимые значения: `C32`, `C39`, `C39+`, `C39E`, `C39E+`, `C93`, `S25`, `S25+`, `I25`, `I25+`, `ITF14`, `C128`, `C128A`, `C128B`, `C128C`, `EAN2`, `EAN5`, `EAN8`, `EAN13`, `UPCA`, `UPCE`, `MSI`, `MSI+`, `POSTNET`, `PLANET`, `TELEPENALPHA`, `TELEPENNUMERIC`, `RMS4CC`, `KIX`, `IMB`, `CODABAR`, `CODE11`, `PHARMA`, `PHARMA2T`
value	Обязательно Строка	-
foreground_color	Необязательно Строка	-
width_scale	Необязательно Целое число	1-10
height	Необязательно Целое число	30-1000

Пример

curl --request POST \
--url 'https://qrdom.ru/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

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

{ "data": { "id": 1 } }

Удалить

Конечная точка

DELETE https://qrdom.ru/api/barcodes/{barcode_id}

Пример

curl --request DELETE \
--url 'https://qrdom.ru/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \