Códigos de barras

Crie códigos de barras em 34 simbologias, com cor, tamanho e rótulo.

Tipos suportados

Passe type como uma destas chaves de simbologia. value deve seguir as regras desse tipo.

  • 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
Criar código de barras

Envie JSON com name, type e value. type é uma chave de simbologia como C128 ou EAN13. Cores, width_scale, height e display_text controlam a imagem renderizada.

NomeTipoObrigatórioPadrãoDescrição
namestringSimRótulo salvo no recurso.
typestringSimC128Chave de simbologia como C128, EAN13 ou UPCA.
valuestringSimDados codificados no código de barras. Devem ser válidos para o tipo escolhido.
project_idintegerNãoProjeto ao qual anexar o recurso.
is_bulkbooleanNãofalseSe true, um código de barras é criado por linha em value.
foreground_colorstringNão#000000Cor dos módulos em HEX.
background_colorstringNão#ffffffCor HEX do fundo. Mantenha mais clara que os módulos.
width_scaleintegerNão2Multiplicador da largura das barras, 1–10.
heightintegerNão30Altura das barras em pixels, 30–1000.
display_textbooleanNãofalseSe true, value é impresso sob as barras.

Exemplo de requisição

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

Mais exemplos

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

Exemplo de resposta

{
  "data": {
    "id": 1,
    "type": "C128",
    "name": "Product SKU",
    "value": "FORQR-1001",
    "barcode": "https://…/barcodes/…/barcode.svg"
  }
}
GET/api/v1/barcodes
Listar código de barras
NomeTipoObrigatórioDescrição
pageintegerNãoPage number (default 1)
results_per_pageintegerNãoItems per page (default 25, max 100)
searchstringNãoSearch term
search_bystringNãoColumn to search
order_bystringNãoSort column
order_typestringNãoasc or desc
datetime_startstringNãoISO datetime filter start
datetime_endstringNãoISO datetime filter end
curl -X GET 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY'
GET/api/v1/barcodes/{id}
Ler um código de barras
NomeTipoObrigatórioDescrição
idintegerSim
curl -X GET 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/v1/barcodes/{id}
Atualizar código de barras
NomeTipoObrigatórioPadrãoDescrição
idintegerSim
namestringNãoRótulo salvo no recurso.
typestringNãoC128Chave de simbologia como C128, EAN13 ou UPCA.
valuestringNãoDados codificados no código de barras. Devem ser válidos para o tipo escolhido.
project_idintegerNãoProjeto ao qual anexar o recurso.
is_bulkbooleanNãofalseSe true, um código de barras é criado por linha em value.
foreground_colorstringNão#000000Cor dos módulos em HEX.
background_colorstringNão#ffffffCor HEX do fundo. Mantenha mais clara que os módulos.
width_scaleintegerNão2Multiplicador da largura das barras, 1–10.
heightintegerNão30Altura das barras em pixels, 30–1000.
display_textbooleanNãofalseSe true, value é impresso sob as barras.

Exemplo de requisição

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}
Excluir código de barras
NomeTipoObrigatórioDescrição
idintegerSim
curl -X DELETE 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parâmetros e exemplos JSON aparecem em inglês. Substitua YOUR_API_KEY pela sua chave.