バーコード

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

バーコードを作成

name、type、value を含む JSON を送ります。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 の各行に 1 つのバーコードが作られます。
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}

バーコードを 1 件取得

名前	型	必須	説明
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 の各行に 1 つのバーコードが作られます。
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 を自分のキーに置き換えてください。