Enterprise API

API anahtarlarıyla DPP verisini güvenli şekilde entegre edin

IZVERA API, ERP, PLM, PIM, tedarikçi portalı ve şirket içi sistemlerin ürün, malzeme, BOM, doküman, rapor ve pasaport yayınlama akışlarına makine-makine erişmesini sağlar. API anahtarı kuruluş workspace’ine bağlıdır ve her istek bu kuruluş kapsamında çalışır.

API Anahtarı Oluştur Teknik Şema Erişimi İste

Temel istek formatı

Canlı ortamda size iletilen API base URL’i kullanın. Anahtar her zaman HTTP header ile gönderilir.

curl -sS https://api.izvera.com/api/products/ \
  -H "X-API-Key: dpp_REPLACE_WITH_YOUR_KEY" \
  -H "Accept: application/json"

Erişim modeli

API anahtarı nasıl oluşturulur?

API anahtarları yalnızca Enterprise planında ve kuruluş sahibi/yöneticisi tarafından oluşturulur. Anahtar oluşturulduğunda tam değer yalnızca bir kez gösterilir; daha sonra sistem sadece önek bilgisini gösterir.

1. Yönetici panelinden oluşturun

Dashboard içinde API Anahtarları sayfasına gidin. Anahtara ayırt edilebilir bir ad verin, gerekli scope’ları seçin ve isteğe bağlı son kullanma süresi belirleyin.

2. Anahtarı güvenli kasada saklayın

Anahtar formatı dpp_... şeklindedir ve tekrar görüntülenemez. CI/CD secret store, vault veya backend ortam değişkeni dışında saklamayın.

3. En az yetki prensibini uygulayın

Sadece okuma yapan entegrasyonlara read, veri yazan entegrasyonlara write, yayın otomasyonlarına ayrıca publish verin.

Yetkilendirme

Scope matrisi

API key scope’u endpoint düzeyinde kontrol edilir. write scope’u yayınlama yetkisi vermez; publish ayrı ve daha kısıtlı bir yetkidir.

Scope	Ne sağlar?	Örnek endpoint
read	Ürün, malzeme, tedarikçi, yayın, rapor ve export verilerini okuma.	GET /api/products/, GET /api/materials/, GET /api/dpp/publications/
write	Operasyonel veri oluşturma ve güncelleme. Yayınlama yetkisi vermez.	POST /api/products/, POST /api/bom-items/, PATCH /api/materials/{id}/
publish	Pasaport yayınlama, yayından kaldırma ve review/publish iş akışları.	POST /api/dpp/{product_id}/publish/, POST /api/dpp/{product_id}/unpublish/

Entegrasyon örnekleri

Sık kullanılan API akışları

Aşağıdaki örnekler canlı entegrasyonda kullanılan temel çağrı biçimini gösterir. Üretim ortamında her zaman HTTPS, idempotency key ve kontrollü hata yönetimi kullanın.

Ürün oluşturma

curl -sS -X POST https://api.izvera.com/api/products/ \
  -H "X-API-Key: dpp_REPLACE_WITH_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "SKU-1001",
    "name": "Organic Cotton Shirt",
    "status": "DRAFT",
    "country_of_origin": "TR"
  }'

Pasaport yayınlama

curl -sS -X POST https://api.izvera.com/api/dpp/{product_id}/publish/ \
  -H "X-API-Key: dpp_REPLACE_WITH_YOUR_KEY" \
  -H "Idempotency-Key: <unique-request-id>"

Yayınlama isteğinde Idempotency-Key göndermek önerilir. Aynı yayın komutunun ağ hatası nedeniyle tekrar çalıştırılması duplicate publication riskini azaltır.

Anahtar iptal etme

curl -sS -X POST https://api.izvera.com/api/api-keys/{key_id}/revoke/ \
  -H "Authorization: Bearer <admin_jwt>"

API anahtarını iptal etme işlemi güvenlik nedeniyle yönetici JWT oturumu ile yapılır; API anahtarı kendi kendini veya başka anahtarları yönetmez.

Kuruluş kapsamı

API anahtarı hangi kuruluşta oluşturulduysa istekler otomatik olarak o workspace kapsamında çalışır.

Ekstra X-Org-ID header’ı göndermeniz gerekmez.

Her okuma/yazma işlemi kuruluş verisiyle sınırlandırılır.

Anahtarı frontend koduna, mobil uygulamaya veya public repository’ye koymayın.

Endpoint haritası

Başlangıç için temel endpoint’ler

Tam OpenAPI şeması staging veya kontrollü üretim erişiminde paylaşılır. Bu tablo entegrasyon planı çıkarırken kullanılacak pratik özettir.

İşlem	Method	Path	Gerekli scope
Ürünleri listele	GET	/api/products/	read
Ürün oluştur	POST	/api/products/	write
BOM bileşeni ekle	POST	/api/bom-items/	write
Malzeme kütüphanesi	GET / POST	/api/materials/	read / write
Pasaportu başlat	POST	/api/dpp/{product_id}/init/	write
Pasaportu yayınla	POST	/api/dpp/{product_id}/publish/	publish
Pasaportu yayından kaldır	POST	/api/dpp/{product_id}/unpublish/	publish
PDF export	GET	/api/exports/passport/{product_id}.pdf	read
Toplu içe aktarma	POST	/api/imports/products/	write
Raporlar	GET / POST	/api/reports/	read

Hata kodları ve operasyonel davranış

401 Geçersiz, süresi dolmuş veya iptal edilmiş API anahtarı.

402 API erişimi Enterprise plan gerektirir.

403 Scope veya kuruluş rolü bu işlem için yeterli değil.

409 Yayınlama/review gate gibi iş kuralı engeli.

429 Rate limit. Backoff ve retry stratejisi uygulayın.

Güvenlik standardı

Anahtarları kısa ömürlü üretin, entegrasyon bazında ayrı anahtar kullanın ve düzenli rotasyon planlayın.

Loglarda ham anahtarı maskeleyin. Sadece ilk 8 karakterlik prefix’i hata ayıklama için saklayın.

Compromise şüphesinde ilgili anahtarı hemen revoke edin ve yeni anahtar ile entegrasyonu yeniden başlatın.

Canlı ortamda self-service ödeme geçici olarak kapalıysa Enterprise API erişimi IZVERA ekibi tarafından manuel aktive edilir.

Production readiness

API entegrasyonuna başlamadan önce ortamınızı doğrulayın

Enterprise plan, aktif kuruluş üyeliği, gerekli scope’lar, canlı API base URL’i, retry/idempotency stratejisi ve secure secret storage hazır olmalıdır.

Teknik Şema Erişimi İste Enterprise Aktivasyon