Viivakoodit

Luo viivakoodeja 34 symbologialla, väri-, koko- ja nimiöasetuksin.

Tuetut tyypit

Anna type yhtenä näistä symbologia-avaimista. value-arvon on noudatettava kyseisen tyypin sääntöjä.

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

Luo viivakoodi

Lähetä JSON kentillä name, type ja value. type on symbologia-avain kuten C128 tai EAN13. Värit, width_scale, height ja display_text ohjaavat renderöityä kuvaa.

Nimi	Tyyppi	Pakollinen	Oletus	Kuvaus
name	string	Kyllä	—	Resurssiin tallennettu nimiö.
type	string	Kyllä	C128	Symbologia-avain kuten C128, EAN13 tai UPCA.
value	string	Kyllä	—	Viivakoodiin koodattu data. On oltava kelvollinen valitulle tyypille.
project_id	integer	Ei	—	Projekti, johon resurssi liitetään.
is_bulk	boolean	Ei	false	Jos true, jokaisesta value-rivistä luodaan yksi viivakoodi.
foreground_color	string	Ei	#000000	Modulin väri HEX-muodossa.
background_color	string	Ei	#ffffff	Taustan HEX-väri. Pidä se modulia vaaleampana.
width_scale	integer	Ei	2	Palkin leveyskerroin, 1–10.
height	integer	Ei	30	Palkin korkeus pikseleinä, 30–1000.
display_text	boolean	Ei	false	Jos true, value tulostetaan palkkien alle.

Pyyntöesimerkki

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
}'

Lisää esimerkkejä

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
}'

Vastausesimerkki

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

GET/api/v1/barcodes

Listaa viivakoodi

Nimi	Tyyppi	Pakollinen	Kuvaus
page	integer	Ei	Page number (default 1)
results_per_page	integer	Ei	Items per page (default 25, max 100)
search	string	Ei	Search term
search_by	string	Ei	Column to search
order_by	string	Ei	Sort column
order_type	string	Ei	asc or desc
datetime_start	string	Ei	ISO datetime filter start
datetime_end	string	Ei	ISO datetime filter end

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

GET/api/v1/barcodes/{id}

Lue yksi viivakoodi

Nimi	Tyyppi	Pakollinen	Kuvaus
id	integer	Kyllä	—

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

PATCH/api/v1/barcodes/{id}

Päivitä viivakoodi

Nimi	Tyyppi	Pakollinen	Oletus	Kuvaus
id	integer	Kyllä	—	—
name	string	Ei	—	Resurssiin tallennettu nimiö.
type	string	Ei	C128	Symbologia-avain kuten C128, EAN13 tai UPCA.
value	string	Ei	—	Viivakoodiin koodattu data. On oltava kelvollinen valitulle tyypille.
project_id	integer	Ei	—	Projekti, johon resurssi liitetään.
is_bulk	boolean	Ei	false	Jos true, jokaisesta value-rivistä luodaan yksi viivakoodi.
foreground_color	string	Ei	#000000	Modulin väri HEX-muodossa.
background_color	string	Ei	#ffffff	Taustan HEX-väri. Pidä se modulia vaaleampana.
width_scale	integer	Ei	2	Palkin leveyskerroin, 1–10.
height	integer	Ei	30	Palkin korkeus pikseleinä, 30–1000.
display_text	boolean	Ei	false	Jos true, value tulostetaan palkkien alle.

Pyyntöesimerkki

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}

Poista viivakoodi

Nimi	Tyyppi	Pakollinen	Kuvaus
id	integer	Kyllä	—

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

Parametrien nimet ja JSON-esimerkit näytetään englanniksi. Korvaa YOUR_API_KEY tilisi avaimella.