REST API · v1

API Entegrasyonu Yazılımınız Cari Plus'la Konuşsun

E-ticaret sitenizi, CRM'inizi ya da kendi yazılımınızı bağlayın: cari, stok, fatura, e-Belge, tahsilat ve gider tek API'de. Sandbox'ta deneyin, webhook ile anında haberdar olun.

  • Sandbox
  • Webhook
  • Tüm paketlerde
9 kaynak grubu

Cariden e-Belgeye.

Sandbox

Canlıyla aynı sözleşme.

Scope ve IP

Anahtar başına yetki.

Webhook

Sorgulamadan haberdar olun.

Temel bilgi

Ön Muhasebe API'si Nedir?

Ön muhasebe API'si, e-ticaret sitesi, CRM ya da kendi yazılımınız gibi sistemlerin cari, stok, fatura ve tahsilat verisini ön muhasebe programıyla otomatik alıp vermesini sağlayan arayüzdür.

Cari Plus API'si REST mimarisindedir ve JSON ile çalışır. Her istek kısa ömürlü bir erişim token'ıyla yapılır, her anahtar yalnız izin verdiğiniz kaynaklara erişir. Sürüm adreste durur (/v1): yanıtlara yeni alanlar eklenebilir ama var olanlar kaldırılmaz, entegrasyonunuz habersiz bozulmaz.

API tüm paketlerde kullanılabilir. Uç noktaların tamamı, örnek istekler ve OpenAPI tanımı API dokümanında.

API
İki yazılımın birbiriyle veri alışverişi yapmasını sağlayan programlama arayüzüdür.
REST API
Kaynaklara adres (URL) ve HTTP yöntemleriyle (GET, POST gibi) erişilen, JSON ile veri taşıyan API türüdür.
Uç nokta (endpoint)
API'de belirli bir kaynağa karşılık gelen adrestir; örneğin cari hesaplar için /v1/current-accounts.
API anahtarı
Yazılımınızı tanıtan client_id ve client_secret çiftidir; Cari Plus'ta Ayarlar → API Anahtarları'ndan oluşturulur.
Erişim token'ı
API anahtarıyla alınan, her istekte Authorization: Bearer başlığıyla gönderilen kısa ömürlü kimliktir.
Refresh token
Süresi dolan erişim token'ını yeniden giriş yapmadan yenilemeye yarayan uzun ömürlü token'dır.
Scope (kapsam)
Bir API anahtarının hangi kaynaklara okuma ya da yazma izni olduğunu belirleyen yetkidir; örneğin products:read.
Sandbox
Canlı veriye dokunmadan entegrasyonu denemek için ayrılmış test ortamıdır.
Webhook
Bir olay olduğunda (fatura oluştu gibi) Cari Plus'ın sizin belirlediğiniz adrese otomatik gönderdiği bildirimdir.
Idempotency-Key
Aynı isteğin tekrar gönderilmesi durumunda çift kayıt oluşmasını önleyen benzersiz istek anahtarıdır.
Artımsal senkron
Her seferinde tüm veriyi değil, yalnız son eşitlemeden sonra değişen kayıtları çekmektir.
Neden API?

Siparişi Bir Yere, Faturayı Başka Yere mi Giriyorsunuz?

Sistemler birbirini görmeyince her kayıt iki kez girilir, stok geç eşitlenir, hata gün sonunda fark edilir.

Çift veri girişi

Sipariş sitede, müşteri CRM'de, fatura muhasebede.

Kayıt bir kez oluşur, API taşır.

Gecikmeli stok

Biten ürün sitede hâlâ satılıyor.

Webhook ve artımsal senkron.

Paylaşılan şifre

Entegrasyon bir kullanıcının şifresiyle çalışıyor.

Scope'lu anahtar, IP kısıtlaması.

Nasıl çalışır?

Anahtardan Canlı Entegrasyona

Panelde anahtarı oluşturun, sandbox'ta deneyin, aynı kodu canlıda çalıştırın.

  1. Anahtar oluşturun

    Ayarlar → API Anahtarları.

  2. Yetkiyi seçin

    Yalnız gereken scope'lar.

  3. Sandbox'ta deneyin

    Canlı veriye dokunmadan.

  4. Token alın

    client_id + client_secret.

  5. Veriyi eşitleyin

    Okuyun, yazın, değişenleri çekin.

  6. Webhook'u dinleyin

    Olay olunca haber alın.

Neler bağlanabilir?

Cariden e-Belgeye 9 Kaynak Grubu

Her grup kendi okuma ve yazma kapsamıyla; anahtara yalnız gerekenleri verin.

Cari hesaplar

Müşteri ve tedarikçileri oluşturun, güncelleyin, listeleyin.

/v1/current-accounts
current_accounts:read current_accounts:write

Ürünler ve varyasyonlar

Ürün kartları ile renk, beden gibi varyasyonlar.

/v1/products
products:read products:write

Stok ve depolar

Stok miktarı, stok hareketleri, depolar ve lokasyonlar.

/v1/warehouses
stock:read warehouses:read

Satış faturaları

Fatura oluşturma ve durum işlemleri; ihracat ve serbest meslek makbuzu dahil.

/v1/sales-invoices
invoices:read invoices:write

e-Belge

Faturayı e-Fatura ya da e-Arşiv olarak gönderin, durumunu okuyun.

/v1/sales-invoices/{id}/edocument-…
edocuments:read edocuments:write

Tahsilat

Faturaya tahsilat işleyin, kasa ve banka hesaplarını görün.

/v1/invoice-collections
collections:read collections:write

Giderler

Gider kayıtları, gider kategorileri ve gelen e-faturalar.

/v1/expenses
expenses:read expenses:write

Gider ödemeleri

Giderlere yapılan ödemeleri kaydedin ve izleyin.

/v1/expense-payments
expense_payments:read expense_payments:write

Teklifler ve hizmetler

Taslak teklif oluşturun; hizmet kartlarını okuyun.

/v1/quotes
quotes:write services:read
Güvenlik

Her Anahtar Yalnız İzin Verdiğiniz Kadar

Anahtara yalnız gereken kapsamları verin; anahtar bağlı olduğu kullanıcının panel yetkileriyle de sınırlıdır. İsterseniz yalnız belirli IP adreslerinden çalışsın.

Kısa ömürlü token

Erişim token'ı 1 saat, refresh token 30 gün geçerli; her yenilemede refresh token da yenilenir. client_secret yalnız bir kez gösterilir.

e-Belge ayrı yetki

GİB'e gönderim e-belge kontörü harcadığı için fatura yetkisinden ayrıdır; yalnız durum okumak için okuma yetkisi yeterli.

Sandbox

Canlıya Dokunmadan Deneyin

Sandbox ortamı canlıyla aynı uç noktaları ve sözleşmeyi kullanır. Burada kestiğiniz e-Belgeler GİB'e gönderilmez; kod hazır olunca yalnız adresi ve anahtarı değiştirirsiniz.

Ayakta mı?

/v1/ping kimlik doğrulama gerektirmez; /v1/me anahtarınızın firmasını ve kapsamlarını döndürür.

Ayrı anahtarlar

Sandbox ve canlı anahtarları yalnız kendi ortamında çalışır; test kodu yanlışlıkla canlı veriye yazamaz.

Güvenilir senkron

Çift Kayıt Yok, Yalnız Değişenler

Ağ koptu, isteği yeniden gönderdiniz: aynı Idempotency-Key ile tekrarlanan istek yeni kayıt açmaz, ilk yanıtı döndürür. Hatalı istek anahtarı tüketmez; düzeltip aynı anahtarla yeniden deneyin.

updated_since

Son eşitlemeden sonra değişen kayıtları çekin; her seferinde tüm listeyi taşımayın.

Sayfalama

page ve per_page ile sayfa sayfa okuyun; sayfa başına en fazla 200 kayıt.

Webhook

Sorgulamayın, Haber Alın

Fatura oluştuğunda ya da değiştiğinde, e-Belge durumu değiştiğinde, tahsilat alındığında, cari ya da stok güncellendiğinde Cari Plus belirlediğiniz adrese bildirim gönderir.

Siparişi kapatın

Tahsilat bildirimiyle sitenizde siparişi ödendi yapın; online tahsilatla birlikte döngü kapanır.

Stoğu eşit tutun

Stok değişince satış kanalınız anında güncellensin; varyasyonlar dahil.

Etkileşimli araç

API İstek Oluşturucu: Senkronunuzu Planlayın

Ortamı ve kaynağı seçin; gereken kapsamı, hazır curl isteğini ve kayıt sayınıza göre kaç istek gerektiğini görün.

İstek

Listeleme isteği oluşturulur; tüm uç noktalar dokümanda.

Ürünler —
Gereken kapsam—Anahtara verin
İlk eşitleme——
Sonraki eşitleme——

                    

Örnek istektir; tarih, şu anki saate göre hesaplanır. Token alma ve yazma istekleri için API dokümanına bakın.

Entegrasyonunuzu bugün başlatın Hesabınızı açın, Ayarlar → API Anahtarları'ndan anahtarınızı oluşturun; 30 gün ücretsiz.
Ücretsiz Deneyin
Geliştirici dokümanı

Örnekli Doküman, OpenAPI Tanımı

Her kaynak için örnek istek ve yanıtlar, hata kodları, kapsam listesi ve OpenAPI tanımı tek yerde. Sürümleme kuralı açık: alanlar kaldırılmaz, geriye uyumsuz değişiklik yeni sürümle gelir.

  • Canlı: api.cariplus.com.tr/v1
  • Sandbox: sandbox-api.cariplus.com.tr/v1
  • Biçim: JSON, yanıtlar data içinde
Senaryolar

Hangi Sistemi Bağlayabilirsiniz?

Cari Plus'ı veri üreten ya da tüketen her yazılıma bağlayın.

E-ticaret Sitesi

Sipariş gelince cari ve fatura oluşsun, e-Arşiv gitsin; stok iki yönde eşit kalsın.

  • Fatura + e-Belge
  • Stok

CRM & Saha Satış

Müşteri kartları ve teklif taslakları CRM'den Cari Plus'a aktarılsın.

  • Cari
  • Teklif

Kendi Yazılımınız

Randevu, abonelik ya da özel ERP sisteminiz faturasını Cari Plus'ta kessin.

  • Satış faturası
  • Webhook

Raporlama & BI

Fatura, gider ve tahsilat verisini değişenleri çekerek BI aracınıza taşıyın.

  • updated_since
  • Sayfalama
Hemen başlayın

Entegrasyona 4 Adımda Geçin

Sandbox'ta yazdığınız kod canlıda değişmeden çalışır.

Anahtar oluşturun

Ayarlar → API Anahtarları; scope ve IP seçin.

Sandbox'ta deneyin

Aynı uçlar, e-Belge GİB'e gitmez.

Canlıya geçin

Canlı anahtarla aynı kodu çalıştırın.

Webhook'u bağlayın

Olaylarda bildirim alın.

Karşılaştırma

Elle Aktarım mı, API mi?

Excel'le ya da elle veri taşımak ile Cari Plus API'siyle entegrasyon arasındaki fark.

Elle veri aktarımı ile Cari Plus API entegrasyonu karşılaştırması
Konu Elle aktarım Cari Plus API
Veri aktarımı Excel'e al, Cari Plus'a yükle; her gün tekrar Sistemler kendiliğinden konuşur
Çift kayıt Aynı fatura iki kez girilir Idempotency-Key tekrarı engeller
Güncellik Gün sonu toplu aktarım Webhook ve artımsal senkron
Yetki Paylaşılan kullanıcı şifresi Scope'lu anahtar, IP kısıtlaması
Deneme Canlı veride deneme yanılma Ayrı sandbox ortamı
Süreklilik Ekran değişince betik bozulur /v1 sözleşmesi, alan kaldırılmaz

Hazır bağlantılar için entegrasyonlar, fatura tarafı için e-Belge sayfasına bakın.

API Entegrasyonu Hakkında Sık Sorulan Sorular

Kimlik doğrulama, kapsamlar, sandbox, webhook, senkron ve sürümleme hakkında en çok merak edilenler.

  • 1. Cari Plus API ile neler yapabilirim?

    Cari hesapları, ürünleri ve varyasyonları, stok hareketlerini ve depoları, satış faturalarını ve e-Belgelerini, tahsilatları, giderleri, gider ödemelerini ve teklifleri okuyup yazabilir; hizmetleri okuyabilirsiniz. Böylece e-ticaret sitenizi, CRM'inizi ya da kendi yazılımınızı Cari Plus'a bağlarsınız.

  • 2. API hangi pakette var?

    API tüm paketlerde kullanılabilir. Cari Plus'ta Ayarlar → API Anahtarları bölümünden anahtar oluşturmanız yeterlidir.

  • 3. Kimlik doğrulama nasıl çalışır?

    API anahtarınızın client_id ve client_secret bilgileriyle /v1/auth/token adresinden erişim token'ı alırsınız ve her istekte Authorization: Bearer başlığıyla gönderirsiniz. Erişim token'ı 1 saat, refresh token 30 gün geçerlidir; her yenilemede yeni bir refresh token verilir.

  • 4. client_secret kaybolursa ne olur?

    client_secret yalnız oluşturulduğu anda bir kez gösterilir. Güvenli bir yerde saklamanız gerekir; kaybederseniz yeni bir anahtar oluşturursunuz.

  • 5. Bir API anahtarının erişimini sınırlayabilir miyim?

    Evet. Her anahtara yalnız ihtiyaç duyduğu kapsamları (scope) verirsiniz; örneğin yalnız ürün okuma. Anahtar bağlı olduğu kullanıcının panel yetkileriyle de sınırlıdır. İsterseniz anahtarı yalnız belirli IP adreslerinden kullanılabilir yaparsınız.

  • 6. Test ortamı var mı?

    Evet. Sandbox ortamı canlıyla aynı uç noktaları ve sözleşmeyi kullanır. Sandbox'ta düzenlenen e-Belgeler GİB'e gönderilmez; anahtarlar yalnız kendi ortamlarında çalışır.

  • 7. Aynı istek iki kez giderse çift kayıt oluşur mu?

    POST isteklerine Idempotency-Key başlığı eklerseniz oluşmaz. Aynı anahtarla tekrarlanan istek yeni kayıt açmak yerine ilk yanıtı döndürür; hatalı istekler anahtarı tüketmez, düzeltip aynı anahtarla yeniden deneyebilirsiniz.

  • 8. Yalnız değişen kayıtları çekebilir miyim?

    Evet. Listelerde updated_since parametresiyle son eşitlemeden sonra değişen kayıtları alırsınız. Listeler sayfalıdır; sayfa başına en fazla 200 kayıt çekilebilir.

  • 9. Webhook desteği var mı?

    Evet. Fatura oluştuğunda ya da değiştiğinde, e-Belge durumu değiştiğinde, tahsilat alındığında ve cari ya da stok değiştiğinde belirlediğiniz adrese bildirim gönderilir; yazılımınız Cari Plus'ı sürekli sorgulamak zorunda kalmaz.

  • 10. API ile e-Fatura gönderebilir miyim?

    Evet. Satış faturasını oluşturup e-Belge olarak gönderebilirsiniz. e-Belge gönderimi ayrı bir yetkiyle açılır, çünkü GİB'e gönderim firmanın e-belge kontörünü kullanır; yalnız durum okumak için okuma yetkisi yeterlidir.

  • 11. Serbest meslek makbuzu ve ihracat faturası API ile düzenlenir mi?

    Evet. Satış faturaları kaynağı ihracat faturası ve serbest meslek makbuzu senaryolarını da kapsar; ayrıntılar API dokümanındaki satış faturaları bölümündedir.

  • 12. Teklifleri API ile tam yönetebilir miyim?

    Bu sürümde teklifler API ile taslak olarak oluşturulur; gönderme, onaylama ve faturaya dönüştürme Cari Plus panelinden yapılır.

  • 13. API sürümü değişirse entegrasyonum bozulur mu?

    Hayır. Sürüm adreste yer alır (/v1). Yanıtlara yeni alanlar eklenebilir ama var olan alanlar kaldırılmaz ve anlamı değişmez; geriye uyumsuz bir değişiklik /v2 olarak yayımlanır ve /v1 çalışmaya devam eder.

  • 14. API dokümanına nereden ulaşırım?

    Tüm uç noktalar, örnek istekler ve OpenAPI tanımı cari-plus.gitbook.io/cari-plus-api adresindeki API dokümanındadır.

Aradığınız cevabı bulamadınız mı?

Tüm SSS'leri Görüntüle Tüm SSS'leri Görüntüle