API Temelleri
API Temelleri
Kimlik doğrulama, ortak header, response, hata ve belge kimliği sözleşmeleri.
Ortak sözleşme: Bu sayfadaki kimlik doğrulama, hata ve korelasyon kuralları hem giden hem gelen irsaliye endpointleri için geçerlidir.
Kimlik Doğrulama
Önce hesap bilgileriyle token alın. Dönen değeri sonraki korumalı çağrıların VbtAuthorization header'ına yazın.
POST/api/Account/Token
API oturumu için yetkilendirme token'ı üretir.
| Request | TokenRequestModel: Email, Password |
| Response | TokenResponseModel: Token |
Token JSON örneğini görüntüle
{
"Email": "entegrasyon@firma.com",
"Password": "GUCLU_PAROLANIZ"
}Header Sözleşmesi
| Header | Değer | Kullanım |
|---|---|---|
Content-Type | application/json | JSON gövdeli çağrılarda. |
VbtAuthorization | Token endpointinden dönen değer | Token dışındaki korumalı endpointlerde. |
Belge Kimlikleri
| Kimlik | Amaç | Kullanım |
|---|---|---|
UUId / ETTN | Belgenin uçtan uca teknik kimliği | Durum, çıktı, silme, güncelleme ve mutabakatta saklanır. |
DespatchAdviceExternalId | ERP'nin giden belge referansı | Tekil tutulur; timeout sonrasında aynı iş olayını sorgulamak için kullanılır. |
DespatchAdviceNumber | Görünen irsaliye numarası | IsDocumentNumberIncluded seçimine göre entegratör veya platform tarafından belirlenir. |
ReceiptAdviceExternalId | ERP'nin irsaliye yanıtı referansı | Yanıt tekrarlarını tekilleştirir. |
Response ve Hata Yönetimi
| Durum | Doğru davranış |
|---|---|
| HTTP başarılı | İşlem gövdesindeki HasError, Errors, Data ve belge kimliklerini değerlendirin. |
| Doğrulama hatası | Hata kodunu alanla eşleştirip aynı iş olayını düzeltilmiş gövdeyle yeniden deneyin. |
| Timeout/bağlantı kopması | Yeni dış referans veya ETTN üretmeden önce dış referansla sorgulayın. |
| Asenkron gönderim | Oluşturma yanıtını nihai teslim kabul etmeyin; durum endpointini terminal sonuca kadar izleyin. |
Yön Bazlı Kaynaklar
| Giden endpointler | Giden İrsaliye Entegratör API |
| Gelen ve yanıt endpointleri | Gelen İrsaliye Entegratör API |
| Kopyalanabilir gövdeler | Giden örnekleri ve gelen işlem örnekleri |