REST (BasicIntegrationApi) ve isteğe bağlı e-İrsaliye (DespatchApi)
Son güncelleme: Son güncelleme: 13.07.2026
Convord, Uyumsoft ile e-Fatura / e-Arşiv için BasicIntegrationApi ve (isteğe bağlı) e-İrsaliye için DespatchApi üzerinden JSON istekleri kullanır. Kimlik doğrulama, dokümandaki gibi her istekte userInfo içinde Username ve Password ile yapılır. OAuth veya ayrı bir “API key” kullanılmaz; alan adı “anahtar” gibi görünse de teknik olarak entegrasyon kullanıcısı ve şifresidir.
Uyumsoft REST örneklerinde görünen userInfo yapısı kullanılır. Paneldeki iki alan buna karşılık gelir; ek bir Bearer token veya ayrı secret key alanı yoktur.
İsterseniz sunucu .env içinde UYUMSOFT_USERNAME / UYUMSOFT_PASSWORD tanımlayıp tüm kiracılar için varsayılan sağlayabilirsiniz; firma panelindeki dolu alanlar önceliklidir.
Barındırma tarafında özellikle şunlar kontrol edilir:
https://efatura.uyumsoft.com.tr/api, test için https://efatura-test.uyumsoft.com.tr/api (path’ler yapılandırmayla birleşir).UYUMSOFT_INVOICE_API_URL, UYUMSOFT_DESPATCH_API_URL.php artisan uyumsoft:testUyumsoft’a fatura gönderirken alıcı tarafında geçerli VKN/TCKN zorunludur. Siparişten fatura oluştururken veya gönderirken sistem uygun uyarıyı verir; müşteri kartını güncellemeniz yeterlidir.
Yalnızca yerel PDF/XML sevk irsaliyesi için sunucu ayarı şart değildir. Gerçekten Uyumsoft üzerinden GİB e-İrsaliye göndermek için:
EINVOICE_PROVIDER=uyumsoftUYUMSOFT_DISPATCH_ENABLED=true — bu modda alıcı müşteride de VKN/TCKN zorunludur.API teknik olarak doğru çalışsa bile Uyumsoft panelinde firma için fatura <strong>seri / ön ek</strong> ve hesap ayarları tanımlı olmalıdır. Aksi halde “seri bulunamadı” gibi mesajlar dönebilir. Detaylar için Uyumsoft desteğinize danışın.
Test URL’si ve örnek hesaplar için Uyumsoft dokümantasyonunu kullanın. Deneme için uyumsoft:test komutu BasicIntegrationApi erişimini smoke test eder.
Genel entegrasyon bağlamı için Entegrasyon Rehberi sayfasına bakın.