Штрихкоды

Создавайте штрихкоды по 34 символикам, с цветом, размером и подписью.

Поддерживаемые типы

Передайте type как один из этих ключей символики. value должен соответствовать правилам этого типа.

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

POST/api/v1/barcodes

Создать штрихкод

Отправьте JSON с name, type и value. type — ключ символики, например C128 или EAN13. Цвета, width_scale, height и display_text управляют отрисованным изображением.

Имя	Тип	Обязательно	По умолчанию	Описание
name	string	Да	—	Метка, сохранённая на ресурсе.
type	string	Да	C128	Ключ символики, например C128, EAN13 или UPCA.
value	string	Да	—	Данные, закодированные в штрихкоде. Должны быть допустимы для выбранного типа.
project_id	integer	Нет	—	Проект, к которому прикрепить ресурс.
is_bulk	boolean	Нет	false	Если true, для каждой строки в value создаётся один штрихкод.
foreground_color	string	Нет	#000000	Цвет модулей в HEX.
background_color	string	Нет	#ffffff	HEX-цвет фона. Делайте его светлее модулей.
width_scale	integer	Нет	2	Множитель ширины полос, 1–10.
height	integer	Нет	30	Высота полос в пикселях, 30–1000.
display_text	boolean	Нет	false	Если true, value печатается под полосами.

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

curl -X POST 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}'

Ещё примеры

EAN-13

curl -X POST 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Retail EAN-13",
  "type": "EAN13",
  "value": "5901234123457",
  "height": 70,
  "display_text": true
}'

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

{
  "data": {
    "id": 1,
    "type": "C128",
    "name": "Product SKU",
    "value": "FORQR-1001",
    "barcode": "https://…/barcodes/…/barcode.svg"
  }
}

GET/api/v1/barcodes

Список штрихкод

Имя	Тип	Обязательно	Описание
page	integer	Нет	Page number (default 1)
results_per_page	integer	Нет	Items per page (default 25, max 100)
search	string	Нет	Search term
search_by	string	Нет	Column to search
order_by	string	Нет	Sort column
order_type	string	Нет	asc or desc
datetime_start	string	Нет	ISO datetime filter start
datetime_end	string	Нет	ISO datetime filter end

curl -X GET 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/barcodes/{id}

Прочитать один штрихкод

Имя	Тип	Обязательно	Описание
id	integer	Да	—

curl -X GET 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/barcodes/{id}

Обновить штрихкод

Имя	Тип	Обязательно	По умолчанию	Описание
id	integer	Да	—	—
name	string	Нет	—	Метка, сохранённая на ресурсе.
type	string	Нет	C128	Ключ символики, например C128, EAN13 или UPCA.
value	string	Нет	—	Данные, закодированные в штрихкоде. Должны быть допустимы для выбранного типа.
project_id	integer	Нет	—	Проект, к которому прикрепить ресурс.
is_bulk	boolean	Нет	false	Если true, для каждой строки в value создаётся один штрихкод.
foreground_color	string	Нет	#000000	Цвет модулей в HEX.
background_color	string	Нет	#ffffff	HEX-цвет фона. Делайте его светлее модулей.
width_scale	integer	Нет	2	Множитель ширины полос, 1–10.
height	integer	Нет	30	Высота полос в пикселях, 30–1000.
display_text	boolean	Нет	false	Если true, value печатается под полосами.

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

curl -X PATCH 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "FORQR-2002",
  "height": 90
}'

DELETE/api/v1/barcodes/{id}

Удалить штрихкод

Имя	Тип	Обязательно	Описание
id	integer	Да	—

curl -X DELETE 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Имена параметров и примеры JSON на английском. Замените YOUR_API_KEY на ключ вашего аккаунта.