Gelir gider defteri API'si

Gelir gider defteri API'si, Gelir-Gider Defteri kayıtlarını kendi uygulamandan yönetir: listele, ekle, güncelle ve sil. Uçlar tarayıcı oturumu yerine API anahtarıyla çalışır.

Hızlı başlangıç

  1. Hesabındaki Geliştirici API'si bölümünden bir anahtar üret; düz metin anahtar yalnızca üretim anında gösterilir.
  2. İsteği https://api.pixepi.com adresine Authorization: Bearer <anahtar> başlığıyla gönder.
  3. Yanıtlar JSON döner; liste uçlarında page, per_page ve filtre alanlarını kullanabilirsin.

Örnek istek

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/kategoriler"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/kategoriler" \
  -H "Authorization: Bearer $PIXEPI_KEY"

Bu aracın uçları

YöntemYolNe yapar
GET/kategorilerKategorileri listeler (ortak sistem kategorileri + kendi kategorilerin).
POST/kategorilerYeni kategori ekler.
POST/kategoriler/{id}Kategoriyi günceller.
POST/kategoriler/{id}/arsivleKategoriyi arşivler; ikinci çağrı durumu değiştirmez.
GET/entriesKayıtları listeler; tarih, tür, kategori ve nota göre filtreler.
POST/entriesYeni kayıt ekler.
POST/entries/{id}Kaydı günceller.
POST/entries/{id}/silKaydı siler.
GET/ozetÖzet kırılımı: ay, kategori ya da tür.
GET/disa-aktar.csvKayıtları CSV olarak dışa aktarır.

Ortak uçlar

YöntemYolNe yapar
GET/api/v1/appsAPI kataloğu
GET/api/v1/apps/gelir-gider-defteriAraç sözleşmesi
GET/api/v1/usageKullanım özeti
GET/api/v1/openapi.jsonOpenAPI 3.1 belgesi

Sınırlar

  • Liste yanıtlarındaki limit alanı kullanım ve üst sınır bilgisini taşır.
  • Kota ve plan bilgisi hesabına bağlıdır; güncel durumu GET /api/v1/usage ile görürsün.

Hata kodları

KodAnlamı
unauthorizedAPI anahtarı yok ya da geçersiz.
forbiddenBu işlem bu anahtarla yapılamaz.
not_foundAraç, iş ya da kayıt bulunamadı (sahiplik çaprazında da 404).
invalid_inputGirdi doğrulamadan geçmedi (eksik/bozuk alan, geçersiz tarih…).
invalid_requestİstek biçimi hatalı.
too_largeDosya ya da gövde boyut sınırını aştı.
unsupported_mediaDosya türü kabul edilmiyor.
not_supportedBu araç bu uçla çalıştırılamaz (durum tutan app).
not_readyİş henüz tamamlanmadı.
expiredÇıktının saklama süresi doldu.
no_outputİş için indirilecek çıktı yok.
invalid_pathÇıktı yolu geçersiz.
quota_exceededKota ya da hız sınırı aşıldı.
rate_limitedKısa sürede çok istek; biraz bekleyip tekrar dene.
csrfTarayıcı formu doğrulaması başarısız (dış API anahtar kullanır).
conflictİşlem mevcut durumla çakıştı.
unavailableAraç geçici olarak kapalı.
internal_errorBeklenmeyen sunucu hatası.

Dokümanlar

Sıkça sorulan sorular

API anahtarını nereden alırım?

Hesabındaki Geliştirici API'si bölümünden anahtar üretirsin; anahtar üretim anında bir kez gösterilir.

İstek nasıl gönderilir?

Uçlar https://api.pixepi.com adresinde çalışır; her isteğe "Authorization: Bearer <anahtar>" başlığı eklenir.

Gelir-Gider Defteri API'si hangi uçları açar?

Beyan edilen uçları yukarıdaki tablo listeler; tümü hesabına bağlı kayıtlarla çalışır ve çapraz erişimde 404 döner.

Hata yanıtı nasıl okunur?

Hata gövdesi {ok:false, error, code, request_id} alanlarını taşır; code değerleri hata kodları tablosundadır.