External API Dokümantasyonu
Express AI barkod API'sini kullanarak sipariş barkodlarınızı programatik olarak alın. PDF, görsel, JSON veya ZPL formatlarında.
Hızlı Entegrasyon
Tek bir API çağrısı ile 500'e kadar barkodu aynı anda alın.
Çoklu Format
PDF, görsel (ZIP), JSON veya ZPL formatlarında çıktı alın.
Güvenli Erişim
API Key ve Secret ile güvenli kimlik doğrulama.
External Barkod API Referansı
Farklı programlama dilleri için örnek kodlar ve detaylı açıklamalar
Endpoint
POST https://expressai.com.tr/api/external-barcodes/{accountId}Request Body (JSON)
{
"apiKey": "EAC_xxxxxxxxxxxx",
"apiSecret": "your-secret-key",
"referenceCodes": ["REF001", "REF002", "REF003"],
"type": "pdf"
}apiKey:API anahtarı
apiSecret:API gizli anahtarı
referenceCodes:Barkod alınacak sipariş referans kodları (max 500)
type:"pdf", "image" (ZIP), "rawJson" (parse edilmiş veriler), "zpl" (ham ZPL kodları)
Başarılı Response (PDF)
{
"success": true,
"type": "pdf",
"downloadUrl": "https://expressai.com.tr/api/external-barcodes/download/{accountId}/pdf-3-1703345678-abc123",
"expiresAt": "2024-12-23T15:30:00.000Z",
"fileName": "pdf-3-1703345678-abc123.pdf",
"totalCount": 3,
"successCount": 3,
"tokenUsed": 2,
"tokenBalance": 148,
"errors": [],
"errorRefs": []
}Başarılı Response (ZIP - Image)
{
"success": true,
"type": "zip",
"downloadUrl": "https://expressai.com.tr/api/external-barcodes/download/{accountId}/zip-3-1703345678-def456",
"expiresAt": "2024-12-23T15:30:00.000Z",
"fileName": "zip-3-1703345678-def456.zip",
"totalCount": 3,
"successCount": 3,
"tokenUsed": 2,
"tokenBalance": 148,
"errors": [],
"errorRefs": []
}Not: ZIP dosyası içinde her barkod görseli referans kodu ile adlandırılır (örn: REF001.jpg, REF002.jpg)
Başarılı Response (rawJson)
{
"success": true,
"type": "rawJson",
"totalCount": 2,
"successCount": 2,
"tokenUsed": 1,
"tokenBalance": 149,
"data": [
{
"referenceCode": "REF001",
"fields": {
"referenceNumber": "888123456",
"senderInfo": "Gönderici Bilgisi",
"senderName": "Gönderici Adı",
"distributionCenter": "Dağıtım Merkezi",
"receiverLabel": "Alıcı Etiketi",
"receiverName": "Alıcı Adı",
"receiverAddress": "Alıcı Adresi 1. Satır",
"receiverAddress2": "Alıcı Adresi 2. Satır",
"receiverAddress3": "Alıcı Adresi 3. Satır",
"receiverCityDistrict": "İstanbul / Kadıköy",
"receiverPhone": "5321234567",
"qrCodeData": "QR Kod Verisi",
"trackingNumber": "123456789012",
"shipmentDate": "2024-12-24",
"paymentType": "Kapıda Ödeme",
"deliveryType": "Standart Teslimat",
"desiCount": "1",
"desiCountText": "1 Desi",
"lastDeliveryDate": "2024-12-26",
"courierZone": "Kurye Bölgesi",
"distributionCenter270": "DC 270",
"distributionLine": "Hat 1",
"distributionZone": "Bölge A"
}
}
],
"errors": [],
"errorRefs": []
}Not: ZPL barkodundan parse edilen kargo bilgileri döndürülür.
Başarılı Response (ZPL)
{
"success": true,
"type": "zpl",
"totalCount": 2,
"successCount": 2,
"tokenUsed": 1,
"tokenBalance": 149,
"data": [
{
"referenceCode": "REF001",
"zpl": "^XA^FO50,50^A0N,50,50^FD...^FS^XZ"
}
],
"errors": [],
"errorRefs": []
}Not: Ham ZPL kodları döndürülür, doğrudan Zebra yazıcılara gönderilebilir.
rawJson Field Açıklamaları
referenceNumber- Referans nosenderInfo- Gönderici bilgisisenderName- Gönderici adıdistributionCenter- Dağıtım merkezireceiverLabel- Alıcı etiketireceiverName- Alıcı adıreceiverAddress- Alıcı adresi (1. satır)receiverAddress2- Alıcı adresi (2. satır)receiverAddress3- Alıcı adresi (3. satır)receiverCityDistrict- İl/İlçereceiverPhone- Alıcı telefonqrCodeData- QR kod verisitrackingNumber- Takip noshipmentDate- Gönderim tarihipaymentType- Ödeme tipideliveryType- Teslimat tipidesiCount- Desi miktarıdesiCountText- Desi yazısılastDeliveryDate- Son dağıtım tarihicourierZone- Kurye bölgesidistributionCenter270- Dağıtım merkezi (270)distributionLine- Dağıtım hattıdistributionZone- Dağıtım bölgesiİndirme Bağlantısı
Dosyalar artık base64 yerine indirme bağlantısı olarak döner. Bağlantı 1 saat geçerlidir ve süre dolduktan sonra erişilemez.
Dosyayı indirmek için downloadUrl adresine GET isteği yapın.
Hata Kodları
INVALID_API_KEY- Geçersiz API KeyINVALID_API_SECRET- Geçersiz API SecretCONNECTION_DISABLED- Bağlantı pasif durumdaRATE_LIMIT_EXCEEDED- Rate limit aşıldı (100 istek/dk)INSUFFICIENT_CREDITS- Yetersiz kredi bakiyesiNO_PRINTABLE_ORDERS- Yazdırılabilir sipariş yokNO_JSON_DATA- rawJson verisi olan sipariş yokNO_ZPL_DATA- ZPL verisi olan sipariş yokDOWNLOAD_EXPIRED- İndirme bağlantısının süresi dolmuşFILE_NOT_FOUND- Dosya bulunamadıRate Limiting
API Key başına dakikada maksimum 100 istek yapılabilir. Response header'larında rate limit bilgileri bulunur:
- X-RateLimit-Limit: Toplam limit
- X-RateLimit-Remaining: Kalan istek hakkı
- X-RateLimit-Reset: Reset zamanı (Unix timestamp)
External Barkod API ile başlamak için
- 1Express AI hesabınıza giriş yapın veya yeni hesap oluşturun.
- 2Ayarlar sayfasından External API bölümüne gidin ve yeni bir API bağlantısı oluşturun.
- 3API Key ve Secret bilgilerinizi kopyalayın ve uygulamanıza entegre edin.
- 4Sipariş referans kodlarınızı göndererek barkodlarınızı alın!
Özel Entegrasyon ile başlamak için
- 1Sipariş kaynağınız için iki HTTP endpoint hazırlayın (GET siparişler + POST statü).
- 2Üç auth yönteminden (API Key+Secret / Basic / Bearer) birini seçin.
- 3Express AI panelinde "Özel Entegrasyon" tipinde yeni bir entegrasyon oluşturun ve endpoint'leri girin.
- 4Bağlantıyı doğrulayın; siparişleriniz otomatik olarak Express AI'e akmaya başlasın.