Labelixa REST API referansı: render ve barkod uç noktaları, istek/yanıt header'ları, hata kodları ve API anahtarı ile 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.
| Yöntem | Yol | Açı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/barcodes | Tek barkod üretir (PNG/SVG/PDF). |
| GET | /v1/barcodes/catalog | Barkod tip kataloğunu (JSON) döndürür. |
| POST | /v1/graphics | Görseli ZPL grafik komutuna (^GF) çevirir. |
| POST | /v1/fonts | TrueType fontu ZPL font komutuna (~DU) çevirir; ?chars= ile alt kümeleme. |
| GET | /v1/plans | Plan katmanlarını ve limitlerini listeler. |
| POST | /v1/accounts | Hesap açar ve API anahtarı üretir. |
| GET | /v1/usage | API anahtarının son 7 günlük kullanımı. |
| Header | Amaç | Değerler |
|---|---|---|
X-API-Key | API anahtarı (query'de key= de olur) | lbx_... |
Accept | Çıktı biçimi | image/png (varsayılan), application/pdf, application/json, application/zpl |
X-Target-Dpmm | ZPL dönüşümünde hedef çözünürlük | 6, 8, 12, 24 |
X-Formatter | ZPL biçimlendirme (application/zpl) | On, Off |
X-Page-Size | PDF sayfa boyutu | A4, A5, A6, Letter, Legal |
X-Page-Layout | Sayfa başına ızgara | örn. 2x3 |
X-Quality | PNG kalitesi | Grayscale, Bitonal |
X-Rotation | Etiketi döndürür | 0, 90, 180, 270 |
| Header | Anlamı |
|---|---|
X-Total-Count | Üretilen toplam etiket sayısı. |
X-Warnings | Atlanan/desteklenmeyen komutların listesi. |
X-Plan | İsteğin tanındığı plan. |
X-RateLimit-Remaining | Bugün kalan istek kotası. |
| Kod | Anlamı |
|---|---|
| 400 | Geçersiz parametre (dpmm, boyut vb.). |
| 413 | İstek gövdesi 1 MB'ı veya etiket sayısı plan limitini aştı. |
| 429 | Hı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.
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 -X POST "https://api.labelixa.com/v1/printers/8dpmm/labels/4x6/0" \
--data "^XA^FO50,60^FDMerhaba^FS^XZ" -H "Accept: application/json"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 -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