Önizleme: Public API henüz yayında değil. Rehberler ilk uçlar açılmadan önce paylaşılan taslaklardır ve değişebilir.

Corendis API'ye giriş

Taslak. Yayımlanmadan önce ürün sahibi ve CTO onayı gerekir.

API nedir?

Corendis public API, kendi sistemlerinizin (e-ticaret sitesi, pazaryeri bağlantısı, WMS, BI aracı, iş ortağı uygulaması) Corendis ile veri alışverişi yapmasını sağlayan REST arayüzüdür. Kök yol /api/v1'dir. Sözleşmesi OpenAPI 3.1 ile yayımlanır.

Corendis'e dışarıdan bağlanmanın desteklenen yolları şunlardır: public API, webhook ve olaylar, Excel/CSV içe ve dışa aktarım. Veritabanına doğrudan erişim hiçbir koşulda verilmez.

Sözleşme garantisi

/api/v1 altındaki sözleşme kırıcı değişiklik almaz. Yeni alan, yeni uç gibi eklemeli değişiklikler yapılabilir; mevcut bir alanın anlamını veya biçimini bozan değişiklik yapılmaz.
Kırıcı değişiklik yalnızca yeni bir major sürümde (/api/v2) yapılır.
Eski major sürüm, yenisi yayımlandıktan sonra en az 12 ay desteklenir.
Ayrıntı: Sınırlar ve sürümleme.

Makine adları İngilizcedir

Public API'de yol, alan, parametre, webhook olay adı ve dosya şablonu sütun anahtarı gibi makine adları İngilizcedir. Örneğin sütun anahtarları sabittir ve dilden bağımsızdır. Hata mesajlarındaki okunabilir metinler (title) ise ayrıca değerlendirilmelidir; programınız karar vermek için metne değil type ve code alanlarına bakmalıdır.

Bazı genel kurallar

Her kaynağın tek kimliği küçük harfli, tireli UUID metnidir. İş kodu (kod) filtre olarak kullanılır, adreste kimlik yerine geçmez.
Para ve miktarlar ondalık nokta ile, ISO 8601 tarih ve UTC zaman damgasıyla taşınır.
POST isteklerinde Idempotency-Key başlığı zorunludur. Aynı anahtar aynı gövdeyle tekrar gelirse yeni kayıt oluşmaz; farklı gövdeyle gelirse 422 döner.
Okuma ve export, abonelik süresi dolsa bile kapanmaz (bkz. Hatalar).

Desteklenmeyen uçlar: `/api/ui`

Corendis web arayüzü kendi iç uçlarını /api/ui altında kullanır. Bu uçlar public değildir, belgelenmez ve web arayüzüyle birlikte önceden haber verilmeden değişir. Web arayüzünün iç uçları desteklenmez; entegrasyonunuzda kullanmayın. Makine istemcisi token'ı bu uçlarda zaten kabul edilmez.