API Referansı

Labelixa REST API referansı: render ve barkod uç noktaları, istek/yanıt header'ları, hata kodları ve API anahtarı ile kimlik doğrulama.

Kimlik doğrulama

Ücretsiz katman anahtarsız çalışır (IP bazlı sınır) ve çıktıya filigran ekler. Anahtar X-API-Key header'ında veya ?key= query parametresinde gönderilir; filigranı kaldırır ve limitleri yükseltir.

Uç noktalar

YöntemYolAçıklama
POST/v1/printers/{dpmm}dpmm/labels/{w}x{h}/{index}ZPL'i tek etikete render eder (PNG veya PDF).
POST/v1/printers/{dpmm}dpmm/labels/{w}x{h}/Tüm etiketleri tek PDF'te döndürür (index'siz).
GET/v1/barcodesTek barkod üretir (PNG/SVG/PDF).
GET/v1/barcodes/catalogBarkod tip kataloğunu (JSON) döndürür.
POST/v1/graphicsGörseli ZPL grafik komutuna (^GF) çevirir.
POST/v1/fontsTrueType fontu ZPL font komutuna (~DU) çevirir; ?chars= ile alt kümeleme.
GET/v1/plansPlan katmanlarını ve limitlerini listeler.
POST/v1/accountsHesap açar ve API anahtarı üretir.
GET/v1/usageAPI anahtarının son 7 günlük kullanımı.

İstek header'ları

HeaderAmaçDeğerler
X-API-KeyAPI anahtarı (query'de key= de olur)lbx_...
AcceptÇıktı biçimiimage/png (varsayılan), application/pdf, application/json, application/zpl
X-Target-DpmmZPL dönüşümünde hedef çözünürlük6, 8, 12, 24
X-FormatterZPL biçimlendirme (application/zpl)On, Off
X-Page-SizePDF sayfa boyutuA4, A5, A6, Letter, Legal
X-Page-LayoutSayfa başına ızgaraörn. 2x3
X-QualityPNG kalitesiGrayscale, Bitonal
X-RotationEtiketi döndürür0, 90, 180, 270

Yanıt header'ları

HeaderAnlamı
X-Total-CountÜretilen toplam etiket sayısı.
X-WarningsAtlanan/desteklenmeyen komutların listesi.
X-Planİsteğin tanındığı plan.
X-RateLimit-RemainingBugün kalan istek kotası.

Hata kodları

KodAnlamı
400Geçersiz parametre (dpmm, boyut vb.).
413İstek gövdesi 1 MB'ı veya etiket sayısı plan limitini aştı.
429Hız/kota sınırı aşıldı; Retry-After header'ı döner.

Barkod API'sinde geçersiz veri, HTTP 200 ile birlikte hatayı bir görsel olarak döndürür (no-code araç uyumu) ve ayrıntı X-Warnings header'ında verilir.

Veri çıkarımı (JSON)

Render uç noktasına Accept: application/json gönderirseniz, etiketteki görünür metin ve barkod alanları koordinatlarıyla birlikte JSON olarak döner (barkodlar tur: barkod ile ayrılır):

cURL — alan çıkarımı
curl -X POST "https://api.labelixa.com/v1/printers/8dpmm/labels/4x6/0" \
     --data "^XA^FO50,60^FDMerhaba^FS^XZ" -H "Accept: application/json"

ZPL dönüştürme (application/zpl)

Accept: application/zpl ile ZPL'iniz yeniden biçimlendirilir (her komut ayrı satır; X-Formatter: Off ile kapatılır) ve X-Target-Dpmm verilirse koordinat/boyut parametreleri kaynak çözünürlükten hedefe ölçeklenir. Veri alanları (^FD) değişmez.

cURL — 8→12 dpmm dönüşümü
curl -X POST "https://api.labelixa.com/v1/printers/8dpmm/labels/4x6/0" \
     --data-binary @etiket.zpl -H "Accept: application/zpl" \
     -H "X-Target-Dpmm: 12" > etiket-12dpmm.zpl