Özet: VixSEO, RESTful API aracılığıyla tüm SEO verilerine programatik erişim sunar. Bu rehberde API yapısını, kimlik doğrulama yöntemini, mevcut endpoint'leri, rate limiting kurallarını ve pratik kullanım senaryolarını detaylı olarak anlatıyoruz. Geliştiriciler, bu API ile özel dashboard'lar, otomasyonlar ve entegrasyonlar oluşturabilir.
VixSEO API'sine Giriş
VixSEO API, platformdaki tüm SEO verilerine programatik erişim sağlayan RESTful bir arayüzdür. Bu API, VixSEO'nun web dashboard'unda gördüğünüz tüm verileri ve daha fazlasını sunarak özel çözümler geliştirmenize olanak tanır.
API, özellikle şu senaryolarda kullanışlıdır: özel dashboard ve raporlama araçları geliştirme, mevcut iş araçlarıyla entegrasyon (Slack, Teams, CRM), toplu veri işleme ve otomasyonları, CI/CD pipeline'larına SEO kontrolü ekleme ve çoklu site verilerini birleştirme.
1. Kimlik Doğrulama
VixSEO API, Clerk tabanlı kimlik doğrulama sistemi kullanır. Her API isteğinde geçerli bir kimlik doğrulama token'ı gereklidir.
Token Alma
- Dashboard üzerinden: VixSEO ayarlar sayfasından API anahtarı oluşturabilirsiniz.
- Programatik: Clerk kimlik doğrulama akışı ile token alabilirsiniz.
Token Kullanımı
Her API isteğinde Authorization header'ına Bearer token eklenmelidir. Token'lar belirli bir süre geçerlidir ve süresi dolduğunda yenilenmelidir. Güvenlik açısından token'larınızı asla istemci tarafı kodunda saklamayın.
2. API Yapısı ve Konvansiyonlar
VixSEO API, RESTful prensiplere uygun bir yapıda tasarlanmıştır:
Base URL
Tüm API endpoint'leri /api/ prefix'i altında yer alır. İşletmeye özel endpoint'ler /api/[business]/ yapısında organize edilmiştir.
HTTP Metodları
- GET: Veri okuma işlemleri. Response body'de ham veri döner.
- POST: Yeni kayıt oluşturma. 201 status kodu ile oluşturulan kayıt döner.
- PUT/PATCH: Mevcut kayıt güncelleme.
- DELETE: Kayıt silme.
{"ok": true}response döner.
Response Formatı
VixSEO API, wrapper envelope kullanmaz. Başarılı isteklerde ham veri doğrudan döner. Hata durumlarında {"error": "Hata açıklaması"} formatında Türkçe hata mesajı döner.
3. Temel Endpoint'ler
İşletme Yönetimi
- GET /api/businesses: Erişim yetkisi olan işletmelerin listesi.
- GET /api/[business]/posts: İşletmenin blog yazıları listesi.
- GET /api/[business]/categories: Blog kategorileri.
- GET /api/[business]/collections: Blog koleksiyonları.
Analytics
- GET /api/[business]/analytics/sc: Search Console genel performans verileri.
- GET /api/[business]/analytics/pages: Sayfa bazlı performans verileri.
- GET /api/[business]/analytics/queries: Sorgu bazlı performans verileri.
- POST /api/[business]/analytics/refresh: GSC verilerini yenile.
SEO Araçları
- GET /api/[business]/keywords: Anahtar kelime takip verileri.
- GET /api/[business]/redirects: Redirect listesi.
- POST /api/[business]/redirects: Yeni redirect oluşturma.
- GET /api/[business]/sitemap: Sitemap verileri.
- GET /api/[business]/sitemap/health: Sitemap sağlık kontrolü.
4. Yetkilendirme ve Roller
VixSEO API, RBAC (Rol Tabanlı Erişim Kontrolü) sistemi kullanır. Her endpoint belirli bir izin seviyesi gerektirir:
- viewer: Yalnızca okuma işlemleri (GET endpoint'ler).
- editor: Okuma ve sınırlı yazma işlemleri.
- manager: İşletme düzeyinde tam yetki.
- admin: Tüm endpoint'lere tam erişim.
Yetersiz yetki durumunda API, 403 status kodu ile hata döner. Kimlik doğrulama eksikliğinde 401 status kodu döner.
5. Rate Limiting
API istekleri, adil kullanım için rate limiting'e tabidir:
- Standart plan: Dakikada 60 istek.
- Profesyonel plan: Dakikada 300 istek.
- Ajans planı: Dakikada 1000 istek.
Rate limit aşıldığında 429 (Too Many Requests) status kodu döner. Response header'larında kalan istek sayısı ve limit sıfırlama zamanı bilgisi yer alır.
6. Pratik Kullanım Senaryoları
Slack Entegrasyonu
VixSEO API'sini kullanarak Slack kanalınıza otomatik SEO bildirimleri gönderebilirsiniz. Günlük sıralama özetleri, haftalık performans raporları ve kritik uyarılar Slack üzerinden ekibinize iletilir.
Özel Dashboard
VixSEO API verileriyle kendi özel dashboard'unuzu oluşturabilirsiniz. React, Vue.js veya başka bir frontend framework ile müşterilerinize özel bir SEO izleme paneli sunabilirsiniz.
CI/CD SEO Kontrolü
Deployment pipeline'ınıza VixSEO API kontrolü ekleyerek, her deployment sonrası otomatik SEO sağlık kontrolü yapabilirsiniz. Sitemap erişilebilirliği, critical sayfa 200 kontrolü ve meta etiket doğrulaması gibi kontrolleri otomatize edebilirsiniz.
Toplu Veri Analizi
API üzerinden çektiğiniz verileri Python, R veya Excel ile işleyerek gelişmiş veri analizi yapabilirsiniz. Korelasyon analizi, tahminleme modelleri ve özel metrikler oluşturabilirsiniz.
7. Hata Yönetimi
API hata kodları ve anlamları:
- 400: Hatalı istek — eksik veya geçersiz parametreler.
- 401: Kimlik doğrulama hatası — geçersiz veya eksik token.
- 403: Yetki hatası — bu işlem için yetkiniz yok.
- 404: Bulunamadı — istenen kaynak mevcut değil.
- 429: Rate limit aşıldı — istek sıklığını azaltın.
- 500: Sunucu hatası — VixSEO tarafında bir sorun oluştu.
Sıkça Sorulan Sorular
API erişimi tüm planlarda mevcut mu?
Temel API erişimi tüm planlarda mevcuttur. Ancak rate limiting ve bazı gelişmiş endpoint'ler plana göre farklılık gösterir.
API ile toplu işlem yapabilir miyim?
Evet, örneğin toplu redirect oluşturma veya birden fazla sitenin verilerini çekme gibi toplu işlemler API üzerinden yapılabilir. Rate limiting kurallarına dikkat edin.
API dökümantasyonu nerede?
Detaylı API dökümantasyonuna VixSEO dashboard'undaki Geliştirici bölümünden erişebilirsiniz. Her endpoint için istek ve response örnekleri mevcuttur.
Sonuç
VixSEO API, platformun tüm gücünü programatik erişime açar. Özel entegrasyonlar, otomasyonlar ve dashboard'lar oluşturarak SEO iş akışınızı tamamen özelleştirebilirsiniz. RESTful yapısı ve kapsamlı endpoint listesi ile geliştiriciler için güçlü bir araçtır.