- Taban adres
https://faturika.com/papi/v1, kimlikX-Api-Keybaşlığıyla; anahtar tek firmaya bağlıdır. - Belge türünü alıcıya göre seçmek için mükellefiyet sorgusu, gönderim öncesi yerel doğrulama ve kodlu Türkçe hata mesajları.
- Tekillik anahtarı (Idempotency-Key) ile çift fatura yok; webhook'la durum anında sizde.
- Hazır modüller ücretsiz: WHMCS ve WooCommerce.
Neler yapılabilir?
| Uç | Ne yapar? |
|---|---|
POST /documents | Taslak belge oluşturur (kontör harcamaz). |
POST /documents/send | Tek çağrıda oluşturur ve resmîleştirme kuyruğuna alır. Gönderim reddedilirse açılan taslak geri alınır. |
GET /documents/{uuid} | Belge durumu, numara, ETTN, hata nedeni ve tahsilatlar. |
POST /documents/{uuid}/send | Taslağı ya da başarısız belgeyi gönderir. |
PATCH /documents/{uuid} | Geç kalan taslağın tarihini 7 gün kuralına göre yerinde günceller. |
GET /documents/{uuid}/file/pdf · xml | Resmî PDF ve UBL-TR XML dosyası. |
POST /documents/{uuid}/cancel | e-Arşiv faturanın GİB iptali. |
POST · DELETE /documents/{uuid}/pay | Tahsilat işler ya da taslaktaki tahsilatı geri alır. |
POST /taxpayers/query | VKN/TCKN ile e-Fatura ve e-İrsaliye mükellefiyeti, unvan ve posta kutusu etiketleri. |
GET /contacts/search · POST /contacts | Cari arama ve ekleme/güncelleme (VKN ile tekil). |
GET /cash-accounts | Tahsilatın işleneceği kasa ve banka hesapları. |
GET /account | Hazırlık kontrolü: kontör bakiyesi, şablon onayı, firma bilgisi eksikleri. |
Desteklenen fatura türleri: satış, iade, tevkifat, tevkifatlı iade, istisna, özel matrah ve ihraç kayıtlı. Döviz olarak TL, USD, EUR ve GBP; e-Arşiv'de internet satışı bilgileri (web adresi, ödeme şekli ve tarihi, taşıyıcı) ayrı bir blokla gönderilir.
İlk fatura: tek istek
Aşağıdaki istek bireysel bir müşteriye e-Arşiv faturasını oluşturur ve gönderir. Aynı Idempotency-Key ile tekrarlanan istek ikinci bir fatura açmaz.
curl -X POST https://faturika.com/papi/v1/documents/send \
-H "X-Api-Key: ftk_live_…" \
-H "Idempotency-Key: siparis-10245" \
-H "Content-Type: application/json" \
-d '{
"document_type": "earchive",
"invoice_type_code": "SATIS",
"issue_date": "2026-09-28",
"contact": {"title": "Ayşe Yılmaz", "tax_number": "11111111111", "email": "ayse@example.com"},
"lines": [{"name": "Yıllık hosting", "quantity": 1, "unit_code": "C62", "unit_price": 1000, "vat_rate": 20}]
}'
Belge önce kuyruğa girer; resmîleşince durumu approved olur. Sonucu GET /documents/{uuid} ile sorgulayabilir ya da webhook'la anında alabilirsiniz.
Hatayı gönderimden önce yakalar
Belge e-Belge sistemine gitmeden önce Faturika'da doğrulanır: alıcı kimlik numarasının uzunluğu ve kontrol basamağı, fatura numarası ile tarih sırası, 7 günlük düzenleme süresi, fatura türüyle vergi uyumu. Düzeltilmesi gereken durum 422 validation_failed ve kodlu bir bulguyla döner; bu durumda kontör düşmez. Onay gerektiren uyarılarda (ör. 7 günden eski tarih) aynı isteği gerekçeyle yeniden gönderirsiniz.
Başarısız her yanıt aynı zarfı taşır: {"code": "…", "message": "…"}. Mesaj Türkçedir ve son kullanıcıya gösterilebilir.
Webhook: durum sizi bulsun
Panelde bir adres tanımladığınızda şu olaylar JSON olarak gönderilir: document.sent, document.status_changed, payment.recorded, incoming.received. Her istek X-Faturika-Signature-V2 başlığında zaman damgalı HMAC-SHA256 imzası taşır; eski bir isteğin yeniden oynatılmasını 5 dakikalık pencereyle reddedersiniz. 2xx dışı yanıtta teslimat artan aralıklarla toplam 5 kez denenir; tekrarları X-Faturika-Delivery kimliğiyle ayıklarsınız.
Güvenlik ve sınırlar
- Anahtar başına dakikada 60 istek; aşımda
429veRetry-Afterbaşlığı. - Anahtarlar panelden oluşturulur ve iptal edilir; her anahtar yalnız kendi firmasının verisine erişir.
- Webhook adresleri yalnız internetten erişilebilir adreslere gider; yönlendirme izlenmez.
- API'de de panelle aynı iş kuralları geçerlidir: seri tarih sırası, 7 gün kuralı, iade faturasında kaynak belge.
Belgeler ve hazır modüller
Kaydolduktan sonra Ayarlar → Entegrasyon → Modüller ve API Belgesi bölümünden OpenAPI 3.1 tanımını (YAML ve JSON) ve tüm uçları, alanları, hata kodlarını ve iş kurallarını anlatan entegrasyon rehberini indirirsiniz. Tanımı Postman, Insomnia ya da Swagger'a aktarıp istemci kodu üretebilirsiniz.
Kod yazmak istemiyorsanız ücretsiz modüllerle başlayın: WHMCS e-Fatura modülü hosting ve abonelik işletmeleri için, WooCommerce e-Fatura eklentisi WordPress mağazaları için. Trendyol Pazaryeri siparişleri için pazaryeri entegrasyonu panelde hazırdır.
Faturalarınızın görünümü API'den bağımsız olarak fatura şablonu editöründe tasarlanır; API ile kestiğiniz belge de logonuzu ve renklerinizi taşır.
Sık sorulan sorular
Faturika API ücretli mi?
Hayır. API erişimi ve API anahtarı için ek ücret yoktur; tüm abonelere açıktır. Panelden ya da API'den gönderilen her e-belge aynı şekilde 1 kontör düşer. Taslak oluşturmak, cari kaydı ve sorgular kontör harcamaz.
API ile hangi belgeleri kesebilirim?
e-Fatura, e-Arşiv fatura ve e-İrsaliye. Fatura türleri: satış, iade, tevkifat, tevkifatlı iade, istisna, özel matrah ve ihraç kayıtlı. Ayrıca sipariş ve yerel (e-belge olmayan) satış/alış kaydı açılabilir.
Alıcının e-Fatura mükellefi olup olmadığını API söyler mi?
Evet. Mükellefiyet sorgusu ucu vergi ya da TC kimlik numarasıyla alıcının e-Fatura ve e-İrsaliye kullanıcısı olup olmadığını, unvanını ve posta kutusu etiketlerini döndürür; önerilen belge türünü de verir.
Aynı faturayı yanlışlıkla iki kez keser miyim?
Belge oluşturma uçları Idempotency-Key başlığını kabul eder. Zaman aşımında aynı anahtarla yeniden denediğinizde ikinci belge açılmaz, ilk isteğin sonucu döner.
Webhook destekleniyor mu?
Evet. Belge gönderildi, belge durumu değişti, tahsilat işlendi ve gelen e-Fatura olayları imzalı (HMAC-SHA256, zaman damgalı) istekle adresinize iletilir; başarısız teslimat artan aralıklarla 5 kez denenir.
Test ortamı var mı?
Ayrı bir test ortamı yoktur. Taslak uçları kontör harcamaz ve belgeyi resmîleştirmez; entegrasyonunuzu taslaklarla deneyip hazır olduğunda gönderim ucunu açabilirsiniz.
İlgili sayfalar
API ile e-Fatura Entegrasyonu
Yazılımınızı e-Fatura/e-Arşiv'e bağlarken mevzuat (VUK 231/5, VUK 509) ve teknik (tekillik, webhook) kontrol listesi.
WHMCS e-Fatura Modülü
Ücretsiz WHMCS modülü: ödenen faturayı e-Arşiv/e-Fatura olarak resmîleştirir, tahsilatı işler, PDF'i müşteriye e-postalar.
WooCommerce e-Fatura Eklentisi
Ücretsiz WooCommerce eklentisi: ödenen siparişe otomatik e-Arşiv/e-Fatura, internet satışı bilgileri, PDF'li müşteri e-postası.
e-Ticaret Entegrasyonları
Trendyol Pazaryeri, WooCommerce eklentisi, WHMCS/WiseCP ve açık API ile siparişten otomatik fatura.