PIM API
CommerceLab PIM (ürün bilgi yönetimi) entegrasyon API'si. Tedarikçiler ve ERP sistemleri ürün, fiyat, stok ve nitelik verilerini bu API ile CommerceLab'e aktarır.
Ortam ve adres
API her firma için ayrı bir adreste (stgapi) çalışır:
| Ortam | Adres |
|---|---|
| Test | https://stgapi.{tenant}.awstest.hebiar.com |
| Prod | https://stgapi.{tenant}.prod.hebiar.com |
{tenant} size iletilen firma kodunuzdur. Bazı firmalarda prod adresi
firmaya özel bir alan adıdır (ör. stgapi.<firma-alan-adı>); size iletilen adresi kullanın.
Önce test ortamında entegrasyonu tamamlayın, prod'a geçişte yalnızca adres ve kimlik
bilgileri değişir.
Kimlik doğrulama
Tüm uçlar kimlik doğrulama ister. İki yöntem desteklenir; Authorization başlığı
Bearer ile başlıyorsa token, aksi halde Basic kabul edilir.
- Basic Auth —
Authorization: Basic base64(kullanıcı:parola). Kimlik bilgileri her istekte CommerceLab kimlik servisinde doğrulanır (sunucu tarafında önbelleklenir). Birden fazla firmaya erişimi olan kullanıcılarTenantbaşlığıyla firma kodunu gönderir. - Bearer token — CommerceLab kimlik servisinden (
/Auth/login) alınan JWT:Authorization: Bearer <token>.
Kimlik doğrulaması başarısız olursa yanıt gövdesiz 401 döner.
Toplu (asenkron) işlemler
sapigw/suppliers/{supplierId}/... uçları isteği kuyruğa alır ve hemen bir
BatchRequestId döner. İşlemin sonucu Toplu işlem sonucunu sorgula ucu ile takip
edilir. Kuyruğa alınamayan istekler (saatlik/günlük istek limiti aşımı vb.) yine 200
ile döner; bu durumda BatchRequestId boş, Message doludur.
Hata yanıtları
Sunucu tarafında yakalanmayan hatalar 500 ve aşağıdaki gövdeyle döner:
{ "NativeErrorCode": -1, "error": "hata açıklaması" }
PIM/Entity/... ve PIM/LookUp/... uçları hatayı 200 içinde IsSuccess: false ile
bildirir — yanıtta her zaman IsSuccess alanını kontrol edin.
JSON alan adları PascalCase döner (IsSuccess, Data); istek gövdesinde alan adları
büyük/küçük harfe duyarlı değildir.
Ortamlar
- Test:
https://stgapi.{tenant}.awstest.hebiar.com - Prod:
https://stgapi.{tenant}.prod.hebiar.com
Kimlik Doğrulama
Ürünler
- POST /sapigw/suppliers/{supplierId}/v2/products — Ürünleri toplu aktar
- PUT /sapigw/suppliers/{supplierId}/v2/products — Ürünleri toplu güncelle
- POST /PIM/SaveProductsManually — Ürün kaydet (PIM modeli)
Fiyat & Stok
İşlem Takibi
- GET /sapigw/suppliers/{supplierId}/products/batch-requests/{batchRequestId} — Toplu işlem sonucunu sorgula
- GET /PIM/transaction/{transactionId}/summary — İşlem özetini sorgula
- GET /PIM/transaction/{transactionId}/product/summary — İşlem ürün sonuçlarını sorgula
Tedarikçi Ürünleri
- POST /PIM/Vendor/Products — Tedarikçi ürünlerini listele
- POST /PIM/Vendor/Products/v2 — Tedarikçi ürünlerini listele (v2)
- POST /PIM/SaveExternalSku — Onaylı ürüne ERP kodu kaydet
Nitelikler
- GET /PIM/GetAttributes — Nitelikleri listele
- POST /PIM/SaveAttributeWithDetail — Nitelik yarat veya güncelle