API Dokümantasyonu

TotalApp REST API'si ile verilerinizi programatik olarak okuyun, yazın ve yönetin. Kimlik doğrulama, hız sınırları ve tüm uç noktalar için tam referans.

Genel Bakış

TotalApp, geliştiricilerin platform verilerine ve işlevlerine erişmesini sağlayan kapsamlı bir REST API sunar. Tüm uç noktalar JSON formatını kullanır, JWT tabanlı kimlik doğrulama gerektirir ve tutarlı hata kodları döndürür.

RESTful Mimari

Standart HTTP metodları (GET, POST, PUT, DELETE) ve öngörülebilir kaynak URL'leri. JSON yanıtları ve açıklayıcı hata mesajları.

JWT Kimlik Doğrulama

Her istek Authorization: Bearer <token> başlığı gerektirir. Token'lar Ayarlar → API anahtarları bölümünden oluşturulur.

Hız Sınırları

Starter: 100 istek/dk. Basic: 500 istek/dk. Standard+: 2000 istek/dk. Enterprise: özel sınır. Sınır aşılınca 429 döner.

Webhook Desteği

Gerçek zamanlı olay bildirimleri için webhook'ları kaydedin. Detaylar için Webhook'lar sayfasına bakın.

Kimlik Doğrulama

API token'ı almak için Ayarlar → Geliştirici → API Anahtarları'na gidin ve Yeni Anahtar Oluştur'a tıklayın. Token yalnızca bir kez görüntülenir — güvenli bir yerde saklayın.

curl -X GET https://app.totalapp.app/api/v1/employees \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Güvenlik Uyarısı

API token'larını kaynak koduna, halka açık depolara veya istemci tarafı koduna gömmeyin. Sunucu ortamı değişkenleri veya gizli yönetim araçları kullanın.

Temel Uç Noktalar

Personel

Metod	Uç Nokta	Açıklama
GET	`/api/v1/employees`	Tüm personeli listele (sayfalama destekli)
GET	`/api/v1/employees/:id`	Tek bir personel kaydını getir
POST	`/api/v1/employees`	Yeni personel oluştur
PUT	`/api/v1/employees/:id`	Personel kaydını güncelle
DEL	`/api/v1/employees/:id`	Personel kaydını sil

Projeler

Metod	Uç Nokta	Açıklama
GET	`/api/v1/projects`	Tüm projeleri listele
GET	`/api/v1/projects/:id/tasks`	Projeye ait görevleri getir
POST	`/api/v1/projects`	Yeni proje oluştur

Finans

Metod	Uç Nokta	Açıklama
GET	`/api/v1/invoices`	Tüm faturaları listele
POST	`/api/v1/invoices`	Yeni fatura oluştur
GET	`/api/v1/expenses`	Harcamaları listele

Hata Kodları

HTTP Kodu	Açıklama
200	Başarılı
201	Kaynak oluşturuldu
400	Geçersiz istek — gerekli alanlar eksik veya hatalı
401	Kimlik doğrulama hatası — token eksik veya geçersiz
403	Erişim reddedildi — bu kaynağa erişim izniniz yok
404	Kaynak bulunamadı
429	Hız sınırı aşıldı — `Retry-After` başlığını kontrol edin
500	Sunucu hatası — tekrar deneyin veya destek ile iletişime geçin

İpucu

Tüm hata yanıtları {"error": "Açıklama", "code": "HATA_KODU"} biçiminde JSON döner. Hata işleme için error.code alanını kullanın.

Sayfalama

Birden fazla kayıt döndüren tüm liste uç noktaları imleç tabanlı sayfalama kullanır:

GET /api/v1/employees?limit=50&cursor=emp_abc123

Yanıt, bir sonraki sayfa için nextCursor içerir. nextCursor boşsa son sayfaya ulaşılmıştır.

Sık Sorulan Sorular

API token'larının geçerlilik süresi var mı?

Oluşturulan API token'ları varsayılan olarak süresiz geçerlidir. İsteğe bağlı sona erme tarihi ayarlayabilir veya dilediğiniz zaman iptal edebilirsiniz.

Sandbox ortamı var mı?

Evet. https://sandbox.totalapp.app/api/v1 adresini kullanın. Sandbox verilerinde yapılan değişiklikler üretim ortamını etkilemez.

API değişikliklerinden nasıl haberdar olabilirim?

API değişiklikleri Ayarlar bölümünden webhook veya e-posta bildirimleri aracılığıyla takip edilebilir. API sürümleme politikamız için Üçüncü Taraf Entegrasyonlar sayfasına bakın.