API Genel Bakış

Perfex CRM SaaS Module, SaaS platformunuzu programatik olarak yönetmenizi sağlayan bir REST API içerir. Şunlar için yararlıdır:

• Özel kayıt sayfaları — Kendi kayıt akışınızı oluşturun
• Üçüncü taraf entegrasyonları — Harici araçlarla (Zapier, Integromat, özel uygulamalar) bağlanın
• Faturalandırma otomasyonu — Harici faturalandırma sistemleriyle senkronize edin
• İzleme — Özel panolar ve izleme araçları oluşturun
• Mobil uygulamalar — Mobil yönetim arayüzleri oluşturun

API ile Başlarken

Adım 1: API'yi Etkinleştirin

1. SaaS Management → SuperAdmin Settings bölümüne gidin
2. API Settings sekmesine tıklayın
3. API'yi ON konumuna getirin
4. Bir API token oluşturun

Adım 2: Kimlik Doğrulama

Tüm API istekleri, istek başlığında Bearer token ile kimlik doğrulaması gerektirir:

Authorization: Bearer YOUR_API_TOKEN_HERE

Adım 3: Temel URL

API temel URL'niz:

https://yoursite.com/api/saas/

yoursite.com değerini gerçek alan adınızla değiştirin.

---

Hızlı Örnek

API ile kiracı oluşturmanın hızlı bir örneği:

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

API Özellikleri

Uç Nokta Grubu	Yapabilecekleriniz
Tenants	Kiracı oluşturma, okuma, güncelleme, silme
Plans	Plan listeleme, oluşturma, güncelleme
Subscriptions	Kiracı aboneliklerini yönetme
Usage	Kiracı kullanımı ve kotasını sorgulama

Uç noktaların tam listesi için API Reference sayfasına bakın.

---

Rate Limiting

API, sunucunuzu korumak için rate limiting uygular:

• Her API token için dakikada 100 istek
• Rate limit başlıkları her yanıtta dahildir

Rate limit aşıldığında 429 Too Many Requests yanıtı alırsınız.

---

En İyi Uygulamalar

1. API token'ınızı gizli tutun — İstemci tarafı kodunda veya genel depolarında asla göstermeyin
2. HTTPS kullanın — API isteklerini her zaman HTTPS üzerinden yapın
3. Hataları uygun şekilde işleyin — Yanıt durum kodlarını kontrol edin ve hataları uygun şekilde işleyin
4. Mümkün olduğunda önbelleğe alın — Aynı veriyi tekrar tekrar sorgulamayın; sık değişmeyen yanıtları önbelleğe alın

bilgi

Özel bir entegrasyon mu gerekiyor? API kullanım senaryonuzu karşılamıyorsa, support üzerinden bize ulaşın. Müşteri geri bildirimlerine dayanarak API'yi sürekli genişletiyoruz.

API Reference