ürün doğrulama API entegrasyonuürün doğrulamaAPI entegrasyonuERP entegrasyonuürün izlenebilirliğibenzersiz ürün kodumarka korumaentegrasyon testi

Ürün Doğrulama API Entegrasyonu: Canlıya Geçiş Rehberi

9 dk okuma

Ürün doğrulama API entegrasyonu, ürün kimlikleri ile üretim, ERP, depo, e-ticaret veya müşteri sistemleri arasında kontrollü veri alışverişi kurar. Başarılı bir entegrasyonun ölçüsü yalnızca iki sistemin bağlantı kurması değildir; doğru ürünün doğru kodla eşleşmesi, hataların izlenmesi ve aynı işlemin yanlışlıkla iki kez uygulanmamasıdır.

En sık görülen tasarım hatası, hangi sistemin hangi kaydın sahibi olduğuna karar vermeden uç noktaları bağlamaktır. Ürün kartı bir sistemde, üretim emri başka bir sistemde, kod durumu ise doğrulama platformunda tutuluyorsa çelişen kayıtlar oluşabilir. Teknik ekip çalışır görünen bir bağlantı kurarken operasyon ekibi hangi veriye güveneceğini bilemeyebilir.

Bu rehber, kod örneği vermekten önce karar çerçevesi sunar. Amaç; veri sahipliği, API sözleşmesi, kod yaşam döngüsü, güvenlik, hata yönetimi ve kabul testlerini satın alma dosyasına dönüştürmektir. Böylece marka, sağlayıcıyla görüşürken yalnızca “API var mı?” değil, “hangi iş akışı hangi kanıtla çalışacak?” sorusunu sorabilir.

Ürün doğrulama API entegrasyonu hangi işi çözmeli?

API, uygulamaların tanımlı kurallarla veri ve işlem paylaşmasını sağlayan arayüzdür. Ürün doğrulama projesinde bu arayüz; ürün kartı açma, benzersiz kod isteme, kodu üretimle eşleştirme, durum güncelleme veya doğrulama olaylarını kurumsal sisteme aktarma gibi görevlerde kullanılabilir. Gerekli görevler, markanın gerçek operasyonuna göre seçilmelidir.

Her veriyi iki yönlü taşımak iyi entegrasyon anlamına gelmez. Ürün adı ve stok kodu ERP'den doğrulama platformuna giderken şüpheli doğrulama sinyali ters yönde olay kaydı olarak dönebilir. İki sistemin de aynı alanı değiştirebilmesi ise sürüm çatışması ve yanlış güncelleme riski doğurur.

Önce entegrasyonun iş sonucunu yazın: üretim emri açıldığında kod talebi oluşması, paketleme tamamlandığında kodların etkinleşmesi veya belirli bir risk olayı geldiğinde inceleme kaydı açılması gibi. Ölçülebilir sonuç tanımlanmadan seçilen uç noktalar, çalışan fakat operasyonel değer üretmeyen bir bağlantıya dönüşebilir.

Veri sahipliği bağlantıdan önce nasıl belirlenir?

Her temel kayıt için tek bir ana kaynak belirleyin. Ürün adı, GTIN, stok kodu ve varyant bilgisinin sahibi ERP olabilir; üretim emri MES'te, tekil doğrulama kimliği ise doğrulama platformunda tutulabilir. Buradaki amaç bütün veriyi tek sisteme taşımak değil, her alanın nerede doğduğunu ve nerede değiştirilebildiğini açıkça göstermektir.

  • Ürün ana verisini oluşturan ve güncelleyen sistem
  • Lot, seri veya tekil ürün kimliğini üreten sistem
  • Kodun basıldı, uygulandı, etkin veya iptal edildi durumlarını yöneten sistem
  • Doğrulama olayını, zamanını ve varsa konum bilgisini kaydeden sistem
  • Şüpheli olayın inceleme ve kapanış kararını yöneten ekip

Aynı fiziksel ürün için kullanılan kimlik düzeyi de başlangıçta netleşmelidir. GS1 Digital Link standardı, GS1 tanımlayıcılarının web adreslerinde tutarlı biçimde temsil edilmesine yönelik bir çerçeve sunar. Marka GS1 yapısı kullanıyorsa GTIN, lot veya seri bilgisinin kendi tekil doğrulama koduyla nasıl ilişkileneceğini veri modelinde ayrıca tanımlamalıdır.

Bu çalışma, lot ve seri bazında ürün takibi kararının entegrasyona doğrudan girdi olduğunu gösterir. Binlerce üründe ortak lot numarası ile her ambalajı ayıran tekil kimlik aynı işi yapmaz. API alanları, işletmenin araştırmak istediği olayı ayırt edecek düzeyi taşımalıdır.

API sözleşmesinde hangi bilgiler bulunmalı?

Sağlayıcının yalnızca uç nokta listesini vermesi yeterli değildir. İstek ve yanıt alanları, zorunlu bilgiler, veri türleri, durum kodları, kimlik doğrulama yöntemi, hız sınırları, sürümleme ve örnek hata gövdeleri belgelenmelidir. OpenAPI Specification, HTTP tabanlı API'lerin insanlar ve araçlar tarafından anlaşılabilecek, dilden bağımsız bir sözleşmeyle tanımlanmasını sağlar.

  • Test ve canlı ortam adresleri ile erişim koşulları
  • Her işlemin istek alanları, yanıtı ve hata kodları
  • Sayfalama, filtreleme, toplu işlem ve dosya sınırları
  • Sürüm değişiklikleri ve geriye dönük uyumluluk politikası
  • Kimlik bilgilerinin oluşturulması, yenilenmesi ve iptali
  • Destek, olay bildirimi ve planlı bakım iletişim yolu

Sözleşmede örnek veri bulunması geliştirme süresini kolaylaştırır, ancak gerçek müşteri veya üretim verisi örneğe taşınmamalıdır. Test kayıtları açıkça işaretlenmeli ve canlı ürün kimlikleriyle karışmamalıdır. Sağlayıcı dokümanı değiştiğinde entegrasyon testinin hangi sürüme göre çalıştığı da kayıt altına alınmalıdır.

Marka ayrıca veri dışa aktarma ve sağlayıcı değişikliği senaryosunu sormalıdır. Ürün kimlikleri, durum geçmişi ve doğrulama olaylarının hangi biçimde alınabildiği; saklama, erişim ve silme sorumluluklarının kimde olduğu yazılı olmalıdır. Bu konu yalnız teknik bağımlılığı değil, operasyonun devamlılığını da etkiler.

Kod yaşam döngüsü sistemler arasında nasıl bağlanır?

Benzersiz kodun yalnızca oluşturulması yetmez; hangi üretim emri için ayrıldığı, basılıp basılmadığı, hangi ürüne uygulandığı ve ne zaman etkinleştiği bilinmelidir. İptal edilen üretimde kullanılmayan kodların durumu da tanımlanmalıdır. Aksi hâlde daha sonra ortaya çıkan bir doğrulama kaydının gerçek bir ürüne ait olup olmadığı araştırılamaz.

Yaşam döngüsü için sınırlı ve açık durumlar kullanın: oluşturuldu, ayrıldı, basıldı, uygulandı, etkin, bloke veya iptal edildi gibi. Her geçişi hangi sistemin yapabileceği ve hangi kanıtın gerektiği belirlenmelidir. Örneğin paketleme tamamlanmadan etkinleşen kod, üretim hattı dışındaki bir etikette yanlış sinyal üretebilir.

Kod ile ürün eşleşmesi toplu dosya, API çağrısı veya üretim hattındaki tarama üzerinden kurulabilir. Yöntemden bağımsız olarak üretim emri, ürün, lot ve kod aralığı arasında denetlenebilir bağ gerekir. ürün doğrulama sistemi uygulama rehberi, bu akışın işletme tarafındaki temel adımlarını ayrıntılandırır.

Hata, tekrar ve kesinti senaryoları nasıl yönetilir?

Ağ kesintisi sırasında yanıt alınamaması, işlemin sunucuda hiç gerçekleşmediği anlamına gelmeyebilir. İstemci aynı talebi yeniden gönderirse ikinci bir kod siparişi, yinelenen etkinleştirme veya mükerrer olay oluşabilir. Bu nedenle her yazma işlemi için benzersiz işlem kimliği, tekrar kontrolü ve son durum sorgusu tasarlanmalıdır.

RFC 9110, PUT ve DELETE gibi yöntemleri idempotent; yani aynı istek tekrarlandığında amaçlanan sunucu etkisi değişmeyen yöntemler olarak tanımlar. POST ise kendiliğinden güvenli tekrar varsayımı taşımaz. Ürün doğrulama entegrasyonu, yöntem adından bağımsız olarak işleme özel tekrar anahtarı veya önceki sonucu bulma yolu istemelidir.

  1. İstek için kurum içinde benzersiz bir işlem kimliği üretin.
  2. Yanıt gelmezse körlemesine yeniden yazmak yerine işlem durumunu sorgulayın.
  3. Geçici hatalar ile veri doğrulama hatalarını ayrı kuyruklarda ele alın.
  4. Başarısız kayıtları ürün ve üretim emri bağlamıyla izleyin.
  5. Manuel düzeltmede kimin neyi değiştirdiğini denetim kaydına alın.

Kuyruklanan işlemlerde sıralama da önemlidir. Ürün kartı oluşmadan kod talebi, kod ayrılmadan etkinleştirme gönderilirse her çağrı teknik olarak geçerli olsa bile iş akışı bozulabilir. Entegrasyon tasarımı bağımlılıkları, zaman aşımını ve telafi adımını açıkça göstermelidir.

Güvenlik ve gizlilik için hangi kontroller gerekir?

API anahtarı veya erişim belirteci kaynak koda, mobil uygulamaya, e-postaya ya da destek kaydına düz metin olarak konmamalıdır. Kimlik bilgileri sunucu tarafında gizli yönetilmeli, yalnız gerekli ortam ve işlemler için yetkilendirilmeli, ayrılan çalışan veya tedarikçi erişimleri kapatılmalıdır. Test ve canlı anahtarları birbirinden ayrılmalıdır.

OWASP API Security Project, nesne ve işlev düzeyinde yetkilendirme, kimlik doğrulama ve kaynak tüketimi gibi riskleri API güvenliğinin temel başlıkları arasında sayar. Her kullanıcı veya entegrasyon hesabı yalnız kendi görevindeki ürün, firma ve işlem kapsamına erişebilmelidir.

  • En az yetkiyle tanımlanmış ayrı entegrasyon hesabı
  • Kimlik bilgilerinin güvenli kasada saklanması ve düzenli yenilenmesi
  • Başarısız giriş, reddedilen erişim ve veri doğrulama hatalarının kaydı
  • İş ihtiyacına göre belirlenmiş hız, sayfa ve toplu işlem sınırları
  • Gereksiz kişisel verinin istek ve loglardan çıkarılması
  • Olay halinde anahtarı iptal etme ve erişimi durdurma prosedürü

OWASP'ın kaynak tüketimi rehberi, çağrı sıklığı, kayıt sayısı ve yük boyutu gibi sınırların iş gereksinimine göre belirlenmesini önerir. Ancak tek bir evrensel limit yoktur. Normal üretim zirvesi ölçülmeli, koruma eşiği gerçek hacmi durdurmayacak biçimde pilotta sınanmalıdır.

Pilot ve kabul testleri nasıl hazırlanır?

Canlıya geçişten önce tek ürün ailesi, sınırlı üretim aralığı ve temsilî hata senaryolarıyla pilot yapın. Test yalnız mutlu yolu değil; eksik alan, hatalı ürün kodu, zaman aşımı, yinelenen istek, yetkisiz erişim ve sırası bozulmuş olayları da kapsamalıdır. Beklenen sonuç her senaryo için test başlamadan yazılmalıdır.

Test alanıÖrnek kontrolKabul kanıtı
Veri eşleşmesiÜrün, lot ve kod doğru bağlanıyor mu?İki sistemde aynı referans
Tekrar yönetimiAynı işlem yeniden gönderildiğinde ne oluyor?Mükerrer kayıt oluşmaması
KesintiBağlantı geri geldiğinde kuyruk nasıl işleniyor?Eksiksiz ve sıralı sonuç
YetkiHesap kapsam dışı ürüne erişebiliyor mu?Reddedilen erişim kaydı
İzlemeHata ürün ve işlemle bulunabiliyor mu?Aranabilir denetim kaydı

Kabul ölçütleri “entegrasyon çalışıyor” cümlesinden daha somut olmalıdır. Hangi alanların eksiksiz taşınacağı, hatanın ne kadar sürede görünür olacağı, tekrar işleminin nasıl önleneceği ve manuel telafinin kim tarafından yapılacağı yazılmalıdır. Performans hedefi varsa, tahmin değil ölçülmüş pilot yüküyle değerlendirilmelidir.

Canlıya geçiş planında geri dönüş adımı da bulunmalıdır. Yeni bağlantı kapatıldığında üretimin nasıl devam edeceği, kuyruktaki kayıtların nasıl korunacağı ve eski yönteme geçici dönüşün kim tarafından başlatılacağı önceden denenmelidir. Başarılı pilot, yalnız yeni akışın değil, kontrollü geri dönüşün de kanıtıdır.

xBarkod entegrasyon görüşmesinde ne doğrulanmalı?

xBarkod'un canlı ana sayfası, ürün başına benzersiz QR kod ve gizli PIN, tüketici doğrulaması ile firma panelinde zaman ve konum takibini aynı akışta tanımlar. Site ayrıca ERP, CRM veya e-ticaret sistemleri için REST API entegrasyonundan söz eder. Proje öncesinde gereken işlemlerin, veri alanlarının, test ortamının ve destek sınırlarının güncel teknik dokümanda ayrıca doğrulanması gerekir.

xBarkod ürün doğrulama çözümünü değerlendirirken entegrasyon görüşmesine ürün ana verisi, üretim emri, kod durumu ve olay akışını gösteren tek sayfalık şemayla girin. Ardından kapsamı, güvenlik sorumluluklarını ve kabul testlerini yazılı teklifin parçası yapın. Maliyet kalemlerini eşit kapsamda değerlendirmek için ürün doğrulama sistemi fiyat rehberinden yararlanabilirsiniz.

Sıkça Sorulan Sorular

Ürün doğrulama API entegrasyonu her firma için gerekli mi?

Hayır. Sınırlı ürün ve düşük işlem hacminde ayrı bir yönetim paneliyle başlamak yeterli olabilir. API; ürün, kod veya olay verisinin mevcut sistemlerle düzenli ve hataya dayanıklı biçimde paylaşılması gerektiğinde değer kazanır. Karar, moda olan mimariye değil manuel iş yükü ve kontrol ihtiyacına dayanmalıdır.

ERP ile hangi bilgiler paylaşılmalıdır?

Gereken alanlar iş akışına bağlıdır. Çoğu değerlendirmede ürün referansı, varyant, üretim emri, lot veya seri bağı, kod durumu ve işlem sonucu ele alınır. Kişisel veri ya da operasyon için gereksiz alanlar otomatik olarak taşınmamalıdır. Her alanın sahibi ve değişiklik yetkisi veri sözlüğünde yazılmalıdır.

API ile toplu dosya aktarımı birlikte kullanılabilir mi?

Evet, uygun bir geçiş veya yedek süreçte iki yöntem birlikte kullanılabilir. Ancak aynı kaydın iki kanaldan yinelenmesini önleyen işlem kimliği ve mutabakat kuralı gerekir. Hangi kanalın ana yöntem, hangisinin kontrollü istisna olduğu operasyon belgesinde açık olmalıdır.

Bağlantı kesilirse üretim durmalı mı?

Bu karar ürün riski ve üretim modeline göre verilir. Bazı akışlar kodları önceden ayırıp bağlantı döndüğünde kayıtları eşitleyebilir; bazıları çevrim içi onay gerektirebilir. Çevrimdışı çalışma, kuyruk sınırı, etkinleştirme yetkisi ve sonradan mutabakat adımı pilotta sınanmalıdır.

API anahtarı kimlerle paylaşılabilir?

Anahtar yalnız entegrasyonu çalıştıran yetkili sunucu ve onu yöneten sınırlı teknik ekip tarafından erişilebilir olmalıdır. Kod deposu, tarayıcı, mobil uygulama, e-posta ve ekran görüntüsü uygun saklama yeri değildir. Ayrı ortamlar için ayrı kimlik bilgisi kullanılmalı; sızıntı şüphesinde iptal ve yenileme yapılmalıdır.

Entegrasyonun başarılı olduğu nasıl anlaşılır?

Başarı, tek bir deneme isteğinin yanıt vermesiyle ölçülmez. Ürün ve kod eşleşmesi doğru olmalı, tekrar çağrıları mükerrer kayıt üretmemeli, hatalar aranabilir olmalı ve kesinti sonrası mutabakat tamamlanmalıdır. Operasyon ekibi de teknik desteğe bağımlı kalmadan sorunlu işlemi bulabilmelidir.

Canlıya geçmeden önce kararları görünür kılın

Ürün doğrulama API entegrasyonunun en değerli çıktısı veri taşımak değil, ürün kimliğinin yaşam döngüsünü güvenilir hâle getirmektir. Veri sahibi, işlem sırası, tekrar davranışı, yetki kapsamı ve hata telafisi yazılıysa geliştirme ekibi ne kuracağını; operasyon ekibi de neyi kontrol edeceğini bilir.

İlk adım olarak tek ürün ailesinin mevcut akışını çizin ve her kaydın sahibini işaretleyin. Ardından sağlayıcının API sözleşmesini bu akışa göre inceleyip normal, hatalı ve kesintili senaryolar için kabul testi oluşturun. Bu hazırlık, gereksiz entegrasyon kapsamını azaltırken canlıya geçiş kararını somut kanıta bağlar.

Diğer Yazılar

Ürün Doğrulama API Entegrasyonu: Canlıya Geçiş Rehberi | xBarkod