Ana içeriğe geç

API Genel Bakış

CyberCert API, RESTful prensiplere uygun olarak tasarlanmıştır. Tüm endpoint'ler /api/v1 prefix'i altında versiyonlanmıştır.

Base URL

https://api.cybercert.com/api/v1

Yerel geliştirme için:

http://localhost:8000/api/v1

Kimlik Doğrulama

API'ye erişim için Laravel Sanctum token authentication kullanılmaktadır. Token'ı header'da göndermeniz gerekir:

Authorization: Bearer \{token\}

Detaylı bilgi için Kimlik Doğrulama sayfasına bakın.

HTTP Metodları

  • GET - Veri okuma
  • POST - Yeni kayıt oluşturma
  • PUT - Tam güncelleme
  • PATCH - Kısmi güncelleme
  • DELETE - Soft delete (yumuşak silme)

Yanıt Formatı

Başarılı Yanıt

{
"id": 1,
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Örnek Kayıt",
"is_active": true,
"created_at": "2025-11-20T12:00:00.000000Z",
"updated_at": "2025-11-20T12:00:00.000000Z"
}

Hata Yanıtı

{
"message": "Validation failed",
"errors": {
"email": ["The email field is required."]
}
}

HTTP Status Kodları

  • 200 OK - Başarılı istek
  • 201 Created - Kayıt oluşturuldu
  • 400 Bad Request - Geçersiz istek
  • 401 Unauthorized - Kimlik doğrulama gerekli
  • 403 Forbidden - Yetki yetersiz
  • 404 Not Found - Kayıt bulunamadı
  • 422 Unprocessable Entity - Validasyon hatası
  • 500 Internal Server Error - Sunucu hatası

Pagination

Liste endpoint'leri pagination kullanır:

{
"data": [...],
"current_page": 1,
"per_page": 15,
"total": 100,
"last_page": 7
}

Query parametreleri:

  • page - Sayfa numarası (varsayılan: 1)
  • per_page - Sayfa başına kayıt (varsayılan: 15, max: 100)

Filtreleme ve Arama

Çoğu liste endpoint'i aşağıdaki parametreleri destekler:

  • search - Genel arama (isim, UUID, vb.)
  • is_active - Aktif/pasif filtresi (true/false)
  • with_trashed - Silinen kayıtları dahil et (true)

Rate Limiting

API rate limiting uygulanmaktadır:

  • Authenticated: 60 istek/dakika
  • Unauthenticated: 30 istek/dakika

API Modülleri

Kimlik Doğrulama

  • Login, Register, Me, Logout

Kullanıcı Yönetimi

  • Kullanıcı CRUD, Kullanıcı Ayarları

RBAC & İzinler

  • Roller, Permission'lar, Kullanıcı İzinleri

Organizasyonlar

  • Organizasyon CRUD, Üye Yönetimi

Müşteriler

  • Müşteri CRUD, Müşteri Detayları

Başvurular

  • Başvuru CRUD, Başvuru Konuları

İçerik Yönetimi

  • İçerik CRUD, Yayınlama

Raporlar & Audit

  • Raporlar, Audit Logları

Bildirimler

  • Bildirim CRUD, Okundu İşaretleme

API Anahtarları

  • API Key CRUD, İptal Etme

Entegrasyonlar

  • Entegrasyon CRUD

Lokalizasyon

  • Diller, Çeviriler

Para Birimi

  • Döviz Kuru, Dönüştürme, Formatlama

Oturumlar

  • Oturum Yönetimi, İptal Etme

Sistem & Cache

  • Sistem Ayarları, Cache Yönetimi

Kod Örnekleri

Farklı diller için hazır kod örnekleri: