API

Gem Logic API, harici sistemlerle entegrasyon yapmanızı ve iş akışlarını otomatikleştirmenizi sağlar. Ürünleri, satışları, kişileri, onarımları, envanter sayımlarını ve yazdırma işlerini programlı olarak yönetmek için kullanabilirsiniz.

API anahtarlarınızı oluşturmak ve yönetmek için Ayarlar ‣ API bölümüne gidin.

Kimlik doğrulama

Tüm API istekleri, x-api-key HTTP başlığında bir API anahtarı içermelidir. Ayarlar ‣ API sayfasından anahtarlar oluşturabilirsiniz. Anahtarlar istediğiniz zaman devre dışı bırakılabilir veya silinebilir.

Örnek istek:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

Tehlike

API anahtarlarınızı gizli tutun. Bunları asla herkese açık depolarda veya istemci tarafı kodda paylaşmayın. Bir anahtar ele geçirilirse, hemen devre dışı bırakın ve yeni bir tane oluşturun.

Temel URL

Tüm uç noktalar, /api/ ön ekinin altında örnek URL’nize göredir:

https://your-instance.gem-logic.com/api/

Yanıt biçimi

Tüm yanıtlar JSON olarak döndürülür. Başarılı istekler 200 (GET için) veya 201 (POST için) durum kodu döndürür. Hatalar uygun durum kodunu bir mesajla birlikte döndürür:

• 200 OK — başarılı GET isteği

• 201 Created — başarılı POST isteği

• 400 Bad Request — geçersiz veya eksik veri

• 401 Unauthorized — geçersiz veya eksik API anahtarı

• 404 Not Found — kaynak mevcut değil

Uç noktalar

Pazaryerleri

Yöntem	GET
URL	/api/marketplaces/
Açıklama	Tüm satış kanallarının listesini döndürür.

Yanıt alanları:

Alan	Tür	Açıklama
id	integer	Benzersiz tanımlayıcı
marketplace	string	Marketplace adı

Ürünler

Ürünleri listele

Yöntem	GET
URL	/api/products/{marketplace_id}
Açıklama	Marketplace’e göre filtrelenmiş ürünleri döndürür. Marketplaces uç noktasından marketplace ID’sini kullanın.

Yanıt alanları:

Alan	Tür	Açıklama
id	integer	Benzersiz tanımlayıcı
item_sku	string	Ürün SKU
created	datetime	Oluşturma tarihi
status	string	Ürün durumu
images	array	Ürün görselleri listesi (id, image)
item_weight	decimal	Ağırlık
item_height	decimal	Yükseklik
item_length	decimal	Uzunluk
item_width	decimal	Genişlik

Ürün görseli oluştur

Yöntem	POST
URL	/api/products/create/image/
Açıklama	Base64 kodlaması kullanarak bir ürün görseli yükleyin. Ürün SKU’su henüz mevcut değilse, otomatik olarak yeni bir ürün oluşturulur.

İstek alanları:

Alan	Tür	Gerekli	Açıklama
item_sku	string	Evet	Görselin ekleneceği ürün SKU’su
image	string (base64)	Evet	Base64 kodlu görsel verisi

Satış

Satışları listele

Yöntem	GET
URL	/api/sales/
Açıklama	Tüm satış siparişlerinin listesini döndürür.

Yanıt alanları:

Alan	Tür	Açıklama
order_id	string	Benzersiz sipariş tanımlayıcısı

Satış oluştur

Yöntem	POST
URL	/api/sales/create/
Açıklama	Yeni bir satış siparişi oluşturur.

Kişiler

Yöntem	GET
URL	/api/contacts/
Açıklama	Tüm kişilerin listesini döndürür.

Yanıt alanları:

Alan	Tür	Açıklama
id	integer	Benzersiz tanımlayıcı
complete_name	string	Tam ad
contact_type	string	Kişi türü
email	string	E-posta adresi
phone	string	Telefon numarası
language	string	Tercih edilen dil

Onarımlar

Onarım oluştur

Yöntem	POST
URL	/api/repairs/create/
Açıklama	İlişkilendirilmiş bir onarım kalemiyle yeni bir onarım siparişi oluşturur. Satış noktası veya bölüm belirtilmezse, mevcut olan ilk seçenek kullanılır.

İstek alanları:

Alan	Tür	Gerekli	Açıklama
client_id	integer	Hayır	Müşteri/kişi ID’si
marketplace	string / integer	Hayır	Satış noktası ID’si veya adı
division_id	integer	Hayır	İş bölümü ID’si
title	string	Hayır	Onarım kaleminin başlığı veya açıklaması
repair_info_1	string	Hayır	Ek onarım yorumu
repair_info_2	string	Hayır	Ek onarım yorumu
repair_info_3	string	Hayır	Ek onarım yorumu
quantity	decimal	Hayır	Miktar (varsayılan: 1)
weight	decimal	Hayır	Ürün ağırlığı
weight_unit	string	Hayır	Ağırlık ölçü birimi
size	string	Hayır	Ürün boyutu
color	string	Hayır	Ürün rengi
engravement	string	Hayır	Gravür metni
client_reference | string		Hayır	Müşterinin referans numarası

Örnek yanıt:

{"message": "Repair created successfully.", "order_id": "R-0001"}

Onarıma ürün ekle

Yöntem	POST
URL	/api/repairs/add-item/
Açıklama	Mevcut bir onarım siparişine yeni bir ürün ekler.

İstek alanları:

Alan	Tür	Gerekli	Açıklama
order_id	string	Evet	Ürünün ekleneceği onarımın sipariş ID’si
item_sku	string	Hayır	Ürünle ilişkilendirilecek ürün SKU’su
title	string	Hayır	Başlık veya açıklama
repair_info_1	string	Hayır	Ek onarım yorumu
repair_info_2	string	Hayır	Ek onarım yorumu
repair_info_3	string	Hayır	Ek onarım yorumu
quantity	decimal	Hayır	Miktar (varsayılan: 1)
weight	decimal	Hayır	Ürün ağırlığı
weight_unit	string	Hayır	Ağırlık ölçü birimi
size	string	Hayır	Ürün boyutu
color	string	Hayır	Ürün rengi
engravement	string	Hayır	Gravür metni
client_reference | string		Hayır	Müşterinin referans numarası
cost	decimal	Hayır	Ürünün maliyeti

Envanter sayımları

Envanter sayımı oluştur

Yöntem	POST
URL	/api/inventory-counts/
Açıklama	Yeni bir envanter sayımı oturumu oluşturur.

Yanıt alanları:

Alan	Tür	Açıklama
id	string	Envanter sayımı ID’si
created_at	datetime	Oluşturma zaman damgası
status	string	Her zaman active
tag_count	integer	Sayılan ürün sayısı

Envanter sayımı ürünlerini listele

Yöntem	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Açıklama	Belirli bir envanter sayımında sayılan tüm ürünleri döndürür.

Yanıt alanları:

Alan	Tür	Açıklama
id	string	Benzersiz tanımlayıcı
created_at	datetime	Ürünün sayıldığı zaman
product_sku	string	Ürün SKU
product_name	string	Ürün adı
quantity	integer	Sayılan miktar

Yazdırma işleri

Yöntem	POST
URL	/api/print-pdf/
Açıklama	Belirli bir yazıcı için yazdırma kuyruğuna bir PDF dosyası yükleyin. Dosya format ve güvenlik açısından doğrulanır. Maksimum dosya boyutu 20 MB’dir. multipart/form-data içerik türünü kullanın.

İstek alanları:

Alan	Tür	Gerekli	Açıklama
pdf	dosya	Evet	Yazdırılacak PDF dosyası (maks 20 MB)
printer_uuid	UUID	Evet	Hedef yazıcının UUID’si
landscape	boolean	Hayır	Yatay modda yazdır (varsayılan: false)

Örnek istek:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

Örnek yanıt:

{"status": "queued", "print_job_id": 42}

İnteraktif API gezgini

Gem Logic, Swagger UI tarafından desteklenen yerleşik bir interaktif API gezgini içerir. Buna Ayarlar ‣ API sayfasındaki API belgeleri bağlantısından erişebilirsiniz. Gezgin, her uç noktayı doğrudan tarayıcınızdan denemenize olanak tanır.

Ayrıca bakınız

• Entegrasyonlar