Özel Yazılım e-Fatura Entegrasyonu

Hazır bir e-ticaret altyapısı kullanmıyorsanız sitenizde dört uç nokta yayınlamanız yeterli. efaturan siparişleri düzenli aralıklarla bu uç noktalardan çeker, ödemesi alınanları faturalar ve isterseniz fatura bilgisini sitenize bildirir.

Belge türleri
e-Fatura ve e-Arşiv Fatura
Faturanın iletimi
Özel Entegrasyon tarafına otomatik
Siparişler
15 dakikada bir kontrol
Ekranda yazılım kodu
Özel Entegrasyon siparişinin panelde faturalanmasını gösteren örnek görünüm: sipariş SP-20417, tutar ₺329,90, e-Fatura.

Özel Entegrasyon ile otomatik faturalama

e-Fatura API entegrasyonu neleri kapsar?

  1. 01

    Dört uç nokta, tek sözleşme

    GET /ping, GET /order-statuses, GET /orders ve POST /invoices. İstek ve yanıtlar JSON biçimindedir; kimlik doğrulama Bearer anahtarla yapılır.

  2. 02

    Durumlara göre sipariş seçimi

    Sitenizdeki sipariş durumları panele getirilir; isterseniz yalnızca seçtiğiniz durumlardaki siparişler çekilir. Faturalama ödenmiş, kargodaki ve teslim edilmiş siparişlerle sınırlıdır.

  3. 03

    Fatura bilgisi sitenize döner

    Fatura kesilip GİB'e iletildikten sonra fatura numarası, ETTN, tarih, toplam ve herkese açık fatura linki POST /invoices ile sitenize gönderilir.

  4. 04

    Kargo ve ödeme bilgisi faturada

    Alıcıdan alınan kargo ücreti faturaya Kargo Bedeli satırı olarak eklenir. Siparişteki GİB ödeme kodu e-Arşiv internet satışı bilgisine yazılır.

Kurulum

Özel Entegrasyon API ile bağlantı nasıl kurulur?

  1. 1

    Uç noktaları yayınlayın

    Geliştirici dokümanındaki dört uç noktayı sitenizde tek bir kök adresin altında, yalnızca HTTPS üzerinden sunun. efaturan için bir API şifresi üretin.

  2. 2

    Mağazayı ekleyin

    Panelde Mağaza Ayarları → Özel Entegrasyon'u seçin. Entegrasyon API adresi ve API Şifresi alanlarını doldurup "Bağlantıyı test et" ile /ping yanıtını doğrulayın.

  3. 3

    Siparişleri deneyin

    Otomatik faturayı kapalı tutup Otomasyon sayfasındaki "Şimdi çalıştır" ile siparişleri çekin. Bir siparişi elle faturalayarak tutarı, KDV'yi ve alıcı bilgisini kontrol edin.

  4. 4

    Otomatik faturayı açın

    Sonuçlar doğruysa mağazada "Otomatik fatura kes" seçeneğini açın. Fatura bilgisinin sitenize iletilmesini de aynı ayar ekranından açabilirsiniz.

Özel Entegrasyon bağlantısı için panelde istenen bilgiler: Entegrasyon API adresi, API Şifresi, Altyapı sağlayıcı.
Siparişi kargoya hazırlayan satıcı

Ayrıntılar

Protokolün faturalama kuralları

Sitenizin döndürdüğü alanlar faturayı doğrudan belirler. Geliştirici dokümanındaki başlıca kurallar şunlardır.

  • Tutarlar ondalık sayıdır (ör. 149.90), tarihler saat dilimli ISO 8601 biçimindedir. unitPrice indirim öncesi birim fiyat, discount satırın toplam indirimidir; KDV dahil olup olmadıkları pricesIncludeVat ile bildirilir.
  • Siparişin id değeri faturalanan birimdir; aynı id'ye ikinci fatura kesilmez. created durumundaki sipariş ödeme alınınca faturalanır, cancelled ve returned siparişlere fatura kesilmez.
  • Kurumsal alıcıda 10 haneli VKN gönderilir; alıcı e-Fatura mükellefiyse e-Fatura, değilse e-Arşiv Fatura kesilir. Bireysel alıcıda TCKN boş bırakılırsa fatura nihai tüketici adına düzenlenir.
  • Siparişi başka bir programla faturaladıysanız invoiced: true gönderin; efaturan bu siparişi atlar.
  • Yanıt süresi 30 saniyeyi geçmemelidir. 429 ve 5xx yanıtlarında istek tekrarlanır; /orders için en fazla 100 sayfa istenir.
  • Aynı sipariş için POST /invoices bildirimi tekrar gelebilir; her seferinde 2xx dönmeniz yeterlidir.

Sık sorulan sorular

Özel Entegrasyon hakkında sık sorulan sorular

Kurulumla ilgili ayrıntılar için bağlantı adımlarına bakabilirsiniz.

Özel Entegrasyon kimler için uygun?

Kendi yazılımıyla çalışan bir e-ticaret siteniz ya da müşterilerine altyapı sunan bir yazılım firmanız varsa uygundur. Mağaza eklerken altyapının size mi, bir ajansa ya da yazılım firmasına mı ait olduğunu belirtirsiniz.

Hangi programlama dilini kullanmalıyım?

Protokol dilden bağımsızdır. HTTPS üzerinden JSON döndüren ve Authorization başlığındaki Bearer anahtarı doğrulayan her sunucu yeterlidir. Hatalı anahtarla gelen isteğe 401 dönmeniz beklenir.

Siparişler ne sıklıkla çekilir?

Varsayılan aralık 15 dakikadır. Her istekte since ve until parametreleriyle bir zaman aralığı gelir; bu aralıkta oluşturulan ya da güncellenen siparişleri döndürmeniz beklenir. İlk eşitlemede kaç günlük siparişin çekileceğini mağaza ayarında seçersiniz.

Kesilen fatura sitemize nasıl bildirilir?

Mağaza ayarında faturanın siteye iletilmesini açarsanız fatura numarası kesinleştikten sonra POST /invoices çağrılır. Gövdede sipariş id'si, fatura numarası, ETTN, tarih, toplam, para birimi ve fatura linki bulunur. Başarısız iletimler 7 gün boyunca yeniden denenir.

API şifresini kim üretiyor?

Siz üretirsiniz. Şifreyi sitenizde tanımlar, efaturan panelinde mağaza eklerken API Şifresi alanına girersiniz. Panelde gizli alan olarak şifreli saklanır.

Uç noktaları yazmadan siparişleri aktarabilir miyim?

Evet. Siparişleri İçe Aktar ekranı, bu protokoldeki JSON sipariş biçimini ve Excel'den kaydedilmiş CSV dosyalarını kabul eder. Tek seferlik ya da ara sıra yapılan aktarımlar için bu yol yeterlidir.

Canlıya geçmeden nasıl test ederim?

Otomatik faturayı kapalı tutup siparişleri çekin ve birkaç siparişi elle faturalayın. NES test ortamında kesilen belgeler GİB'e gönderilmez; tutarları ve alıcı bilgilerini bu ortamda doğrulayabilirsiniz.

Özel Entegrasyon siparişlerinizi faturalamaya başlayın

efaturan şu an davetle kullanılıyor. Erken erişim talebinizi bırakın; hesabınız açıldığında ilk faturaları NES test ortamında, belgeler GİB'e gitmeden birlikte kontrol edelim.