API dokümantasyonu

ZPL etiketini HTTP isteğiyle PNG'ye çevir. Kargo, e-ticaret ve depo sistemlerinden doğrudan çağrılabilir.

Hızlı başlangıç

  1. Hesap oluştur veya giriş yap.
  2. Hesabım sayfasından bir API anahtarı oluştur. Anahtar yalnızca oluşturulduğu anda gösterilir; kopyala.
  3. Aşağıdaki "API'yi dene" bölümüne anahtarı yapıştırıp bir etiket gönder, ya da kendi sisteminden POST /convert çağır.

İlk isteğin

Bir ZPL etiketini PNG olarak almak için tek istek yeter. Dört dilde de aynı sonucu verir.

curl -X POST 'https://zpl.podyumplus.com/convert' \
  -H 'X-API-Key: <ANAHTAR>' \
  -H 'Content-Type: text/plain; charset=utf-8' \
  --data-raw '^XA^CI28^FO40,40^A0N,40,40^FDAlıcı: Ahmet Yılmaz^FS^XZ' \
  -o etiket.png

Yanıt başarılıysa PNG dosyası gelir. Hata olursa {"error": "..."} JSON'u döner; hata kodları aşağıda.

Kimlik doğrulama

Her /convert isteğinde X-API-Key başlığı gerekir. Anahtar, hesabınıza bağlıdır ve günlük kullanım hakkı hesap başına sayılır.

X-API-Key: zpl_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Anahtarı gizli tut. Anahtarı tarayıcı koduna, herkese açık depolara veya mobil uygulamalara gömme. Sızarsa Hesabım sayfasından sil ve yenisini oluştur.

Uç noktalar

Yöntem ve yolKimlikNe yapar
POST /convertAPI anahtarıZPL'i PNG'ye çevirir. Ana uç nokta.
GET /healthYokServis çalışıyor mu. {"ok": true} döner.

Parametreler

AdNeredeDeğerlerAçıklama
X-API-KeyBaşlıkMetinZorunlu. Hesabınızın anahtarı.
Content-TypeBaşlıktext/plain veya application/jsonDüz ZPL göndermek için text/plain; JSON gövde için application/json.
dpmmSorgu6, 8, 12, 24Yazıcı çözünürlüğü: 152, 203 (varsayılan), 300 ve 600 dpi.
formatSorgupng (varsayılan), json, pdfpng: ilk etiketin PNG'si. json: tüm etiketler base64 PNG olarak JSON içinde. pdf: tüm etiketler, her biri ayrı sayfa olarak tek PDF (sayfa boyutu etiketin gerçek ölçüsü).
graySorgu1Gri tonlu (anti-aliased) çıktı. Verilmezse siyah-beyaz.
rotateSorgu0 (varsayılan), 90, 180, 270Çıktı görüntüsünü saat yönünde döndürür. 90 ve 270'te genişlik ile yükseklik yer değiştirir.
widthSorgu10 – 300 (mm)Etiket genişliği. Verilmezse ZPL'deki ^PW kullanılır.
heightSorgu10 – 600 (mm)Etiket yüksekliği. Verilmezse ZPL'deki ^LL kullanılır.

Etiket boyutu ZPL içindeki ^PW (genişlik) ve ^LL (yükseklik) değerlerinden alınır. Belirtilmemişse 4×6 inç kullanılır. Türkçe karakterler için etikette ^CI28 kullanmak gerekmez; kodlama belirtilmemişse UTF-8 varsayılır.

Yanıtlar ve hatalar

Başarılı yanıt (200)

Varsayılan: ilk etiketin PNG'si, Content-Type: image/png. Yanıt başlığı X-Label-Count toplam etiket sayısını verir.

{
  "count": 2,
  "labels": [
    { "width": 812, "height": 600, "png_base64": "iVBORw0KGgo..." },
    { "width": 812, "height": 600, "png_base64": "iVBORw0KGgo..." }
  ]
}

Hata yanıtları

Hatalar her zaman {"error": "..."} biçiminde JSON olarak döner.

KodAnlamıNe yapmalı
400Geçersiz ZPL (^XA yok), hatalı dpmm, 10'dan fazla etiketİstek gövdesini ve parametreleri kontrol et.
401Anahtar eksik, yanlış veya silinmişAnahtarı kontrol et; gerekirse yenisini oluştur.
405Yanlış yöntem (ör. GET /convert)POST kullan.
413İstek gövdesi 512 KB'tan büyükEtiketi küçült veya parçala.
429Günlük kullanım hakkı dolduErtesi gün (UTC) tekrar dene.
500Beklenmeyen hata veya çizim zaman aşımıTekrar dene; sürerse etiketi bize ilet.
503Sunucu yoğun, kuyruk doluKısa bir süre sonra tekrar dene.

Sınırlar

  • İstek başına: en fazla 512 KB gövde ve 10 etiket.
  • Günlük kullanım: hesap başına 100 istek (her /convert isteği bir hak sayılır). Limit UTC gece yarısında sıfırlanır.
  • Çizim süresi: etiket başına en fazla 5 saniye.
  • Eşzamanlılık: sunucu aynı anda birkaç çizim yapar; yoğunlukta 503 dönebilir.

Kod örnekleri

cURL, JavaScript, PHP ve Python örnekleri için ana sayfadaki API bölümüne bak. Hızlı bir cURL örneği:

curl -X POST 'https://zpl.podyumplus.com/convert?dpmm=8' \
  -H 'X-API-Key: <ANAHTAR>' \
  -H 'Content-Type: text/plain' \
  --data-raw '^XA
^CI28
^FO40,40^A0N,40,40^FDAlıcı: Ahmet Yılmaz^FS
^XZ' \
  -o etiket.png

API'yi dene

Anahtarını gir, bir etiket gönder ve sonucu burada gör. İstekler doğrudan bu sunucuya gider; anahtar tarayıcı dışına çıkmaz ve sayfa kapandığında silinir.

Eşdeğer cURL